[feature] project view 2000

.github/workflows/unit-tests.yml

@@ -7,16 +7,27 @@ on:
     branches: [ dev, master ]
 
 jobs:
+  commons-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Run tests
+        run: bazel test //commons/...
+
   bazelrunner-test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up JDK 11
-      uses: actions/setup-java@v1
-      with:
-        java-version: 11
-    - name: Run tests
-      run: bazel test //bazelrunner/...
+      - uses: actions/checkout@v2
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Run tests
+        run: bazel test //bazelrunner/...
 
   projectview-test:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -2,35 +2,37 @@
 <!-- Keep a Changelog guide -> https://keepachangelog.com -->
 
 ## [Unreleased]
-### Changed
+### Features 🎉
+- New, better project view! Now you can configure installer as well! | [#143](https://github.com/JetBrains/bazel-bsp/pull/143)
+
+### Changes 🔄
 - Improved heuristics for guessing source roots. It looks directory structures such as `src/java` or `main/java`. | [#126](https://github.com/JetBrains/bazel-bsp/pull/126)
 
-### Fixed
+### Fixes 🛠️
 - Now the project is built using bazel version `3.7.2`, as the rules currently used are no longer supported by bazel. | [141](https://github.com/JetBrains/bazel-bsp/pull/141)
 
 
 ## [1.0.1] - 24.09.2021
-### Added
+### Features 🎉
 - [This](CHANGELOG.md) changelog. | [#97](https://github.com/JetBrains/bazel-bsp/pull/97)
 
-### Changed
+### Changes 🔄
 - Implementation of e2e tests. Have been moved to the `e2e` module and are now based on execution scenarios. | [#83](https://github.com/JetBrains/bazel-bsp/pull/83)
 - Github actions e2e tests execution - e2e tests are executed in parallel. | [#84](https://github.com/JetBrains/bazel-bsp/pull/84)
 - Project structure - now it is multi module project. | [#87](https://github.com/JetBrains/bazel-bsp/pull/87)
 - Github actions unit tests execution - each module has a separate job. | [#89](https://github.com/JetBrains/bazel-bsp/pull/89)
 - Created [document](docs/BUMPVERSION.md) with release tips. | [#91](https://github.com/JetBrains/bazel-bsp/pull/91)
 
-### Removed
+### Removed ✂️
 - Old implementation of e2e tests. | [#86](https://github.com/JetBrains/bazel-bsp/pull/86)
 
-### Fixed
+### Fixes 🛠️
 - Warnings generated by the [WORKSPACE file](WORKSPACE). | [#81](https://github.com/JetBrains/bazel-bsp/pull/81)
 - Semantic versioning parser - now it can parse every valid version. | [#93](https://github.com/JetBrains/bazel-bsp/pull/93)
 - `exports` attribute propagation to the BSP | [#98](https://github.com/JetBrains/bazel-bsp/pull/98)
 - Now all `scala_junit_test` based rules (including `scala_specs2_junit_test`) are included in the BSP tests, unfortunately without test classes. | [#101](https://github.com/JetBrains/bazel-bsp/pull/101)
 
 ## [1.0.0] - 23.08.2021
-### Added
 - Everything...
 
 

README.md

@@ -54,9 +54,9 @@ cs launch -r m2Local org.jetbrains.bsp:bazel-bsp:<your version> -M org.jetbrains
 
 
 ## Project Views
-In order to work on huge monorepos you might want to specify directories and targets to work on. To address this issue, Bazel BSP supports part of the [Project Views](https://ij.bazel.build/docs/project-views.html) introduced by Google. Currently you can use following rules: `directories`, `targets` and `import`. 
+In order to work on huge monorepos you might want to specify directories and targets to work on. To address this issue, Bazel BSP supports (partly) the [Project Views](https://ij.bazel.build/docs/project-views.html) introduced by Google.
 
-Simply create a `projectview.bazelproject` file, specify rules inside and run the server. If no such files will be found, by default entire project will be loaded. 
+Check [project view readme](projectview/README.md) for more info.
 
 
 ## Tests

commons/src/main/java/org/jetbrains/bsp/bazel/commons/BUILD

@@ -7,5 +7,6 @@ java_library(
     deps = [
         "@maven//:ch_epfl_scala_bsp4j",
         "@maven//:com_google_guava_guava",
+        "@maven//:io_vavr_vavr",
     ],
 )

commons/src/main/java/org/jetbrains/bsp/bazel/commons/BetterFiles.java

@@ -0,0 +1,17 @@
+package org.jetbrains.bsp.bazel.commons;
+
+import com.google.common.io.CharSource;
+import com.google.common.io.Files;
+import io.vavr.control.Try;
+import java.nio.charset.Charset;
+import java.nio.file.Path;
+
+public final class BetterFiles {
+
+  public static Try<String> tryReadFileContent(Path filePath) {
+    return Try.success(filePath)
+        .map(Path::toFile)
+        .map(file -> Files.asCharSource(file, Charset.defaultCharset()))
+        .mapTry(CharSource::read);
+  }
+}

commons/src/main/java/org/jetbrains/bsp/bazel/commons/Constants.java

@@ -64,5 +64,7 @@ public class Constants {
 
   public static final String SCALA_TEST_MAIN_CLASSES_ATTRIBUTE_NAME = "main_class";
 
-  public static final String DEFAULT_PROJECT_VIEW_FILE = "projectview.bazelproject";
+  public static final String PROJECT_VIEW_FILE_PATH = "projectview.bazelproject";
+  public static final String DEFAULT_PROJECT_VIEW_FILE_PATH =
+      ".bazelbsp/default-projectview.bazelproject";
 }

commons/src/test/java/org/jetbrains/bsp/bazel/commons/BUILD

@@ -0,0 +1,14 @@
+load("@rules_java//java:defs.bzl", "java_test")
+
+java_test(
+    name = "BetterFilesTest",
+    size = "small",
+    srcs = ["BetterFilesTest.java"],
+    runtime_deps = [
+        "@maven//:junit_junit",
+    ],
+    deps = [
+        "//commons/src/main/java/org/jetbrains/bsp/bazel/commons",
+        "@maven//:io_vavr_vavr",
+    ],
+)

commons/src/test/java/org/jetbrains/bsp/bazel/commons/BetterFilesTest.java

@@ -0,0 +1,45 @@
+package org.jetbrains.bsp.bazel.commons;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.nio.file.Paths;
+import org.junit.Test;
+
+public class BetterFilesTest {
+
+  @Test
+  public void shouldReturnFailureForNotExistingFile() {
+    // given
+    var filePath = Paths.get("file/doesnt/exist");
+
+    // when
+    var fileContent = BetterFiles.tryReadFileContent(filePath);
+
+    // then
+    assertTrue(fileContent.isFailure());
+  }
+
+  @Test
+  public void shouldParseExistingFile() throws IOException {
+    // given
+    var file = File.createTempFile("test", "file");
+    file.deleteOnExit();
+    var filePath = file.toPath();
+
+    var fileWriter = new FileWriter(file);
+
+    fileWriter.write("test content");
+    fileWriter.close();
+
+    // when
+    var fileContent = BetterFiles.tryReadFileContent(filePath);
+
+    // then
+    assertTrue(fileContent.isSuccess());
+    assertEquals("test content", fileContent.get());
+  }
+}

docs/BUMPVERSION.md

@@ -1,5 +1,7 @@
 # Bump Version
+
 If you want to bump version (for example, before a release) you should do this in the following places:
+
 - `central-sync/VERSION`
 - `maven_coordinates` in `server/src/main/java/org/jetbrains/bsp/bazel/BUILD`
 - `VERSION` in `commons/src/main/java/org/jetbrains/bsp/bazel/commons/Constants.java`

docs/kotlin.md

@@ -1,6 +1,9 @@
 # BSP Kotlin
-In order to fully have the experience to use BSP over kotlin, make sure that you're using at least version `0da862aaa11db26f6a113dcec5f6828bfd186ac9` of `rules_kotlin`. This will ensure
+
+In order to fully have the experience to use BSP over kotlin, make sure that you're using at least
+version `0da862aaa11db26f6a113dcec5f6828bfd186ac9` of `rules_kotlin`. This will ensure
 that compilation diagnostics are being delivered to you.
+
 ```
 rules_kotlin_version = "0da862aaa11db26f6a113dcec5f6828bfd186ac9"
 rules_kotlin_sha = "6fda2451b9aaf78a8399e6e5d13c31c8ddc558e87de209a7cfd5ddc777ac7877"
@@ -15,4 +18,5 @@ kotlin_repositories() # if you want the default
 kt_register_toolchains() # to use the default toolchain
 ```
 
-This changes have not been merged yet and progress can be accompanied [here](https://github.com/bazelbuild/rules_kotlin/pull/359).
+This changes have not been merged yet and progress can be
+accompanied [here](https://github.com/bazelbuild/rules_kotlin/pull/359).

docs/scala.md

@@ -1,6 +1,8 @@
 # Toolchain Registration for Scala
+
 In order to fully use Bazel BSP for Scala projects make sure to use at least version
- ``d8bce245a96ca9ab721324bc8daa984aa13fa0f7`` of `rules_scala`:
+`d8bce245a96ca9ab721324bc8daa984aa13fa0f7` of `rules_scala`:
+
 ```
 http_archive(
     name = "io_bazel_rules_scala",
@@ -13,7 +15,9 @@ bazel_version(name = "bazel_version")
 ```
 
 Make sure that your registered toolchain has Compilation Diagnostics enabled:
+
 - At a BUILD file:
+
 ```
 load("@io_bazel_rules_scala//scala:scala_toolchain.bzl", "scala_toolchain")
 
@@ -30,7 +34,9 @@ toolchain(
     visibility = ["//visibility:public"],
 )
 ```
+
 - At the WORKSPACE file:
+
 ```
 register_toolchains(
     "<label_to_build_file>:diagnostics_reporter_toolchain"

e2e/runTest.sh

@@ -36,11 +36,16 @@ fi
 bsp_path="$(bazel info bazel-bin)/server/src/main/java/org/jetbrains/bsp/bazel/bsp-install"
 echo "Building done."
 
-echo "Installing BSP..."
+echo "Cleaning project directory..."
 if [ "$#" -eq 2 ]; then
   cd "$TEST_PROJECT_PATH" || exit
 fi
-$bsp_path
+rm -r .bsp/ > /dev/null 2>&1
+rm -r .bazelbsp/ > /dev/null 2>&1
+echo "Cleaning project directory done!"
+
+echo "Installing BSP..."
+$bsp_path || exit
 echo "Installing done."
 echo "Environment has been prepared!"
 echo -e "-----------------------------------\n"

install/src/main/java/org/jetbrains/bsp/bazel/install/BUILD

@@ -3,10 +3,14 @@ load("@rules_java//java:defs.bzl", "java_library")
 java_library(
     name = "install",
     srcs = glob(["*.java"]),
-    resources = ["aspects.bzl"],
+    resources = [
+        "aspects.bzl",
+        "default-projectview.bazelproject",
+    ],
     visibility = ["//install:__subpackages__"],
     deps = [
         "//commons",
+        "//projectview:parser",
         "@maven//:ch_epfl_scala_bsp4j",
         "@maven//:com_google_code_gson_gson",
         "@maven//:com_google_guava_guava",