Skip to content

Setup SemanticDB tests #5253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2018
Merged

Setup SemanticDB tests #5253

merged 1 commit into from
Oct 16, 2018

Conversation

olafurpg
Copy link
Contributor

This commit updates the SemanticDB tests to assert that the output from
converting TASTy to SemanticDB is the same as the SemanticDB produced by
the semanticdb-scalac compiler plugin for Scala 2.12.7. Test failures
report a diff like this:

Test dotty.semanticdb.Tests.testExample failed: java.lang.AssertionError:
--- tasty
+++ scala2
-class Example {
-  val a: String = "1"
+class Example /*example/Example#*/  {
+  val a /*example/Example#a.*/ : String /*scala/Predef.String#*/  = "1"

The "tasty" output is currently identical to the original source file
because the TASTy to SemanticDB converter doesn't do anything.
Once the converter is updated to emit SymbolOccurrence
(https://scalameta.org/docs/semanticdb/specification.html#symboloccurrence)
then the "tasty" output will include inline comments like
class Example /* pkg/Example# */ that can be read as "the symbol
pkg/Example# was resolved next to the identifier on the left".
The spec for SemanticDB symbols can be found here:

To run the tests you must first produce the SemanticDB files for the
semanticdb/input project by running the following commands:

cd semanticdb/input
sbt compile

It's possible to include the semanticdb/input project in the main Dotty
build but I tried to limit the number of changes to the main build.

We use the org.scalameta:semanticdb_2.12 dependency to construct
SemanticDB data structures. If there is interest it's possible to
replace that dependency with a pure-Java module. I don't estimate it's a
lot of work, I have just never used the Java protobuf binding generator.

Copy link
Member

@dottybot dottybot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, and thank you for opening this PR! 🎉

All contributors have signed the CLA, thank you! ❤️

Commit Messages

We want to keep history, but for that to actually be useful we have
some rules on how to format our commit messages (relevant xkcd).

Please stick to these guidelines for commit messages:

  1. Separate subject from body with a blank line
  2. When fixing an issue, start your commit message with Fix #<ISSUE-NBR>:
  3. Limit the subject line to 72 characters
  4. Capitalize the subject line
  5. Do not end the subject line with a period
  6. Use the imperative mood in the subject line ("Add" instead of "Added")
  7. Wrap the body at 80 characters
  8. Use the body to explain what and why vs. how

adapted from https://chris.beams.io/posts/git-commit

Have an awesome day! ☀️

This commit updates the SemanticDB tests to assert that the output from
converting TASTy to SemanticDB is the same as the SemanticDB produced by
the semanticdb-scalac compiler plugin for Scala 2.12.7.  Test failures
report a diff like this:

```diff
Test dotty.semanticdb.Tests.testExample failed: java.lang.AssertionError:
--- tasty
+++ scala2
-class Example {
-  val a: String = "1"
+class Example /*example/Example#*/  {
+  val a /*example/Example#a.*/ : String /*scala/Predef.String#*/  = "1"
```

The "tasty" output is currently identical to the original source file
because the TASTy to SemanticDB converter doesn't do anything.
Once the converter is updated to emit `SymbolOccurrence`
(https://scalameta.org/docs/semanticdb/specification.html#symboloccurrence)
then the "tasty" output will include inline comments like
`class Example /* pkg/Example# */` that can be read as "the symbol
`pkg/Example#` was resolved next to the identifier on the left".
The spec for SemanticDB symbols can be found here:

- Scala symbols: https://scalameta.org/docs/semanticdb/specification.html#scala-symbol
- Java symbols: https://scalameta.org/docs/semanticdb/specification.html#java-symbol

To run the tests you must first produce the SemanticDB files for the
semanticdb/input project by running the following commands:

```
cd semanticdb/input
sbt compile
```

It's possible to include the semanticdb/input project in the main Dotty
build but I tried to limit the number of changes to the main build.

We use the org.scalameta:semanticdb_2.12 dependency to construct
SemanticDB data structures. If there is interest it's possible to
replace that dependency with a pure-Java module. I don't estimate it's a
lot of work, I have just never used the Java protobuf binding generator.
@olafurpg olafurpg changed the title Setup SemanticDB tests. Setup SemanticDB tests Oct 13, 2018
@nicolasstucki nicolasstucki self-assigned this Oct 13, 2018
@nicolasstucki
Copy link
Contributor

@olafurpg could you just add a README in the semanticdb folder with the instructions of how to run the tests. Otherwise it LGTM.

@nicolasstucki nicolasstucki merged commit a362b71 into scala:master Oct 16, 2018
@olafurpg olafurpg deleted the semanticdb branch October 17, 2018 07:19
@olafurpg
Copy link
Contributor Author

@nicolasstucki done #5268

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants