v2023.3

.github/workflows/ci.yml

@@ -15,9 +15,7 @@ jobs:
         with:
           go-version: '1.21'
       - name: golangci-lint
-        uses: golangci/[email protected]
-        with:
-          version: latest
+        uses: reviewdog/action-golangci-lint@v2
 
   test:
     runs-on: ${{ matrix.os }}
@@ -38,31 +36,91 @@ jobs:
       - uses: actions/setup-go@v4
         with:
           go-version: '1.21'
+      - name: Set up gotestfmt
+        uses: gotesttools/gotestfmt-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
       - if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: docker/login-action@v3
         with:
           registry: registry.jetbrains.team
           username: ${{ secrets.SPACE_USERNAME }}
           password: ${{ secrets.SPACE_PASSWORD }}
-      - run: go test -v ./... -coverprofile cover.out -coverpkg=./...
+      - name: Run tests (with coverage)
+        if: ${{ matrix.os != 'windows-latest' }}
+        run: |
+          set -euo pipefail
+          go test -json -v ./... -coverprofile coverage-${{ matrix.os }}.out -coverpkg=./... 2>&1 | tee /tmp/gotest.log | gotestfmt
+        env:
+          QODANA_LICENSE_ONLY_TOKEN: ${{ secrets.QODANA_LICENSE_ONLY_TOKEN }}
+      - name: Run tests (with coverage) for Windows
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: go test -v ./... -coverprofile coverage-${{ matrix.os }}.out -coverpkg=./...
         env:
           QODANA_LICENSE_ONLY_TOKEN: ${{ secrets.QODANA_LICENSE_ONLY_TOKEN }}
-      - if: startsWith(matrix.os, 'ubuntu')
-        uses: JetBrains/qodana-action@main
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-${{ matrix.os }}.out
+          path: coverage-${{ matrix.os }}.out
+
+  code-quality:
+    runs-on: ubuntu-latest
+    needs: [ lint, test ]
+    permissions:
+      checks: write
+      pull-requests: write
+      actions: read
+      contents: write
+      security-events: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: docker/login-action@v3
+        with:
+          registry: registry.jetbrains.team
+          username: ${{ secrets.SPACE_USERNAME }}
+          password: ${{ secrets.SPACE_PASSWORD }}
+      - name: Download all coverage artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: cov/
+      - name: Merge coverage profiles
+        run: |
+          go install -v github.com/hansboder/gocovmerge@latest
+          mkdir -p .qodana/code-coverage
+          export PATH=$PATH:$(go env GOPATH)/bin
+          ls -R cov/
+          gocovmerge cov/coverage-macos-latest.out/coverage-macos-latest.out cov/coverage-ubuntu-latest.out/coverage-ubuntu-latest.out cov/coverage-windows-latest.out/coverage-windows-latest.out > .qodana/code-coverage/coverage.out
+      - uses: JetBrains/qodana-action@main
         env:
           QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
         with:
           args: --fail-threshold,0
-      - if: startsWith(matrix.os, 'ubuntu')
-        uses: github/codeql-action/init@v2
+      - uses: github/codeql-action/init@v2
         with:
           languages: go
-      - if: startsWith(matrix.os, 'ubuntu')
-        uses: github/codeql-action/autobuild@v2
-      - if: startsWith(matrix.os, 'ubuntu')
-        uses: github/codeql-action/analyze@v2
-      - if: startsWith(matrix.os, 'ubuntu')
-        name: install chocolatey
+      - uses: github/codeql-action/autobuild@v2
+      - uses: github/codeql-action/analyze@v2
+
+  release-nightly:
+    runs-on: ubuntu-latest
+    needs: [ lint, test, code-quality ]
+    permissions:
+      checks: write
+      pull-requests: write
+      actions: read
+      contents: write
+      security-events: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.21'
+      - name: install chocolatey
         run: |
           mkdir -p /opt/chocolatey
           wget -q -O - "https://github.com/chocolatey/choco/releases/download/${CHOCOLATEY_VERSION}/chocolatey.v${CHOCOLATEY_VERSION}.tar.gz" | tar -xz -C "/opt/chocolatey"
@@ -71,14 +129,12 @@ jobs:
           chmod +x /usr/local/bin/choco
         env:
           CHOCOLATEY_VERSION: 1.2.0
-      - if: startsWith(matrix.os, 'ubuntu')
-        uses: goreleaser/goreleaser-action@v5
+      - uses: goreleaser/goreleaser-action@v5
         with:
           distribution: goreleaser
           version: latest
           args: --snapshot --clean --debug
-      - if: startsWith(matrix.os, 'ubuntu') && github.ref == 'refs/heads/233'
-        run: |
+      - run: |
           cd dist
           gh release --repo JetBrains/qodana-cli delete nightly -y || true
           git push --delete origin nightly || true

README.md

@@ -38,11 +38,11 @@ You can also add the linter by its name with the `--linter` option (e.g. `--lint
 
 #### macOS and Linux
 ##### Install with [Homebrew](https://brew.sh) (recommended)
-```console
+```shell
 brew install jetbrains/utils/qodana
 ```
 ##### Install with our installer
-```console
+```shell
 curl -fsSL https://jb.gg/qodana-cli/install | bash
 ```
 Also, you can install `nightly` or any other version (e.g. `v2023.2.9`) the following way:
@@ -52,15 +52,15 @@ curl -fsSL https://jb.gg/qodana-cli/install | bash -s -- nightly
 
 #### Windows
 ##### Install with [Windows Package Manager](https://learn.microsoft.com/en-us/windows/package-manager/winget/) (recommended)
-```console
+```shell
 winget install -e --id JetBrains.QodanaCLI
 ```
 ##### Install with [Chocolatey](https://chocolatey.org)
-```console
+```shell
 choco install qodana
 ```
 ##### Install with [Scoop](https://scoop.sh)
-```console
+```shell
 scoop bucket add jetbrains https://github.com/JetBrains/scoop-utils
 scoop install qodana
 ```
@@ -72,7 +72,7 @@ from [this page](https://github.com/JetBrains/qodana-cli/releases/latest).
 
 Or, if you have Go installed, you can install the latest version of the CLI with the following command:
 
-```console
+```shell
 go install github.com/JetBrains/qodana-cli/v2023@main
 ```
 
@@ -90,7 +90,7 @@ If you know what linter you want to use, you can skip this step.
 
 Also, Qodana CLI can choose a linter for you. Just run the following command in your **project root**:
 
-```console
+```shell
 qodana init
 ```
 
@@ -99,7 +99,7 @@ qodana init
 Right after you configured your project (or remember linter's name you want to run),
 you can run Qodana inspections simply by invoking the following command in your project root:
 
-```console
+```shell
 qodana scan
 ```
 
@@ -112,7 +112,7 @@ After the analysis, the results are saved to `./<userCacheDir>/JetBrains/<linter
 Inside the directory `./<userCacheDir>/JetBrains/<linter>/results/report`, you can find a Qodana HTML report.
 To view it in the browser, run the following command from your project root:
 
-```console
+```shell
 qodana show
 ```
 
@@ -141,7 +141,7 @@ Configure a project for Qodana:
 prepare Qodana configuration file by analyzing the project structure
 and generating a default configuration qodana.yaml file.
 
-```
+```shell
 qodana init [flags]
 ```
 
@@ -167,7 +167,7 @@ Note that most options can be configured via qodana.yaml (https://www.jetbrains.
 But you can always override qodana.yaml options with the following command-line options.
 
 
-```
+```shell
 qodana scan [flags]
 ```
 
@@ -222,7 +222,7 @@ be viewed via the file:// protocol (by double-clicking the index.html file).
 https://www.jetbrains.com/help/qodana/html-report.html 
 This command serves the Qodana report locally and opens a browser to it.
 
-```
+```shell
 qodana show [flags]
 ```
 
@@ -237,6 +237,33 @@ qodana show [flags]
   -r, --report-dir string    Specify HTML report path (the one with index.html inside) (default <userCacheDir>/JetBrains/<linter>/results/report)
 ```
 
+### send
+
+Send a Qodana report to Cloud
+
+#### Synopsis
+
+Send the report (qodana.sarif.json and other analysis results) to Qodana Cloud.
+
+If report directory is not specified, the latest report will be fetched from the default linter results location.
+
+If you are using other Qodana Cloud instance than https://qodana.cloud/, override it with declaring `ENDPOINT` environment variable.
+
+```shell
+qodana send [flags]
+```
+
+#### Options
+
+```
+  -h, --help                 help for send
+  -l, --linter string        Override linter to use
+  -i, --project-dir string   Root directory of the inspected project (default ".")
+  -r, --report-dir string    Specify HTML report path (the one with index.html inside)  (default "/Users/tv/Library/Caches/JetBrains/Qodana/e3b0c442-250e5c26/results/report")
+  -o, --results-dir string   Override directory to save Qodana inspection results to (default "/Users/tv/Library/Caches/JetBrains/Qodana/e3b0c442-250e5c26/results")
+  -y, --yaml-name string     Override qodana.yaml name
+```
+
 ### view
 
 View SARIF files in CLI
@@ -245,7 +272,7 @@ View SARIF files in CLI
 
 Preview all problems found in SARIF files in CLI.
 
-```
+```shell
 qodana view [flags]
 ```
 
@@ -271,7 +298,7 @@ A command-line helper for Qodana pricing to calculate active contributors* in th
 ** Ultimate Plus plan currently has a discount, more information can be found on https://www.jetbrains.com/qodana/buy/
 
 
-```
+```shell
 qodana contributors [flags]
 ```
 
@@ -289,7 +316,7 @@ A command-line helper for project statistics: languages, lines of code. Powered
 
 #### Synopsis
 
-```
+```shell
 qodana cloc [flags]
 ```
 
@@ -316,7 +343,7 @@ as there is some additional configuration tuning required that differs from proj
 
 It's easy to try Qodana locally by running a _simple_ command:
 
-```console
+```shell
 docker run --rm -it -p 8080:8080 -v <source-directory>/:/data/project/ -v <output-directory>/:/data/results/ -v <caches-directory>/:/data/cache/ jetbrains/qodana-<linter> --show-report
 ```
 

cloud/cloud.go

@@ -19,6 +19,7 @@ package cloud
 import (
 	"bytes"
 	"encoding/json"
+	"fmt"
 	log "github.com/sirupsen/logrus"
 	"io"
 	"net/http"
@@ -28,18 +29,26 @@ import (
 )
 
 const (
+	QodanaEndpoint     = "ENDPOINT"
 	DefaultEndpoint    = "qodana.cloud"
-	baseUrl            = "https://api.qodana.cloud"
 	maxNumberOfRetries = 3
 	waitTimeout        = time.Second * 30
 	requestTimeout     = time.Second * 30
 )
 
+func getCloudBaseUrl() string {
+	return fmt.Sprintf("https://%s", GetEnvWithDefault(QodanaEndpoint, DefaultEndpoint))
+}
+
+func getCloudApiBaseUrl() string {
+	return fmt.Sprintf("https://api.%s", GetEnvWithDefault(QodanaEndpoint, DefaultEndpoint))
+}
+
 // GetCloudTeamsPageUrl returns the team page URL on Qodana Cloud
 func GetCloudTeamsPageUrl(origin string, path string) string {
 	name := filepath.Base(path)
 
-	return strings.Join([]string{"https://", DefaultEndpoint, "/?origin=", origin, "&name=", name}, "")
+	return strings.Join([]string{"https://", GetEnvWithDefault(QodanaEndpoint, DefaultEndpoint), "/?origin=", origin, "&name=", name}, "")
 }
 
 type QdClient struct {
@@ -92,7 +101,7 @@ func (client *QdClient) getProject() RequestResult {
 }
 
 func (client *QdClient) doRequest(path, method string, headers map[string]string, body []byte) RequestResult {
-	url := baseUrl + path
+	url := getCloudApiBaseUrl() + path
 	var resp *http.Response
 	var err error
 

cloud/cloud_test.go

@@ -17,7 +17,10 @@
 package cloud
 
 import (
+	"encoding/json"
 	"net/http"
+	"os"
+	"path/filepath"
 	"testing"
 )
 
@@ -45,3 +48,43 @@ func TestValidateToken(t *testing.T) {
 		t.Errorf("Problem")
 	}
 }
+
+func TestGetReportUrl(t *testing.T) {
+	for _, tc := range []struct {
+		name           string
+		jsonData       jsonData
+		reportUrlFile  string
+		expectedReport string
+	}{
+		{
+			name:           "valid json data and url",
+			jsonData:       jsonData{Cloud: cloudInfo{URL: "https://cloud.qodana.com/report/url"}},
+			reportUrlFile:  "https://raw.qodana.com/report/url",
+			expectedReport: "https://cloud.qodana.com/report/url",
+		},
+		{
+			name:           "invalid json data, valid url file data",
+			jsonData:       jsonData{Cloud: cloudInfo{URL: ""}},
+			reportUrlFile:  "https://raw.qodana.com/report/url",
+			expectedReport: "https://raw.qodana.com/report/url",
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			dir := t.TempDir()
+			jsonFile := filepath.Join(dir, openInIdeJson)
+			jsonFileData, _ := json.Marshal(tc.jsonData)
+			if err := os.WriteFile(jsonFile, jsonFileData, 0644); err != nil {
+				t.Fatal(err)
+			}
+			urlFile := filepath.Join(dir, legacyReportFile)
+			if err := os.WriteFile(urlFile, []byte(tc.reportUrlFile), 0644); err != nil {
+				t.Fatal(err)
+			}
+
+			actual := GetReportUrl(dir)
+			if actual != tc.expectedReport {
+				t.Fatalf("Expected \"%s\" but got \"%s\"", tc.expectedReport, actual)
+			}
+		})
+	}
+}