✨ QD-13135 Detect and set VCS information on CLI level

Author: andreiiur

internal/core/container.go

@@ -30,6 +30,7 @@ import (
 	"strings"
 
 	"github.com/JetBrains/qodana-cli/internal/cloud"
+	"github.com/JetBrains/qodana-cli/internal/platform/git"
 	"github.com/docker/docker/api/types/image"
 	"github.com/docker/docker/api/types/network"
 
@@ -285,7 +286,7 @@ func getDockerOptions(c corescan.Context, image string) *backend.ContainerCreate
 	cmdOpts := GetIdeArgs(c)
 
 	updateScanContextEnv := func(key string, value string) { c = c.WithEnvExtractedFromOsEnv(key, value) }
-	qdenv.ExtractQodanaEnvironment(updateScanContextEnv)
+	qdenv.ExtractQodanaEnvironment(git.GetGitEnv(c.RepositoryRoot(), c.LogDir()), updateScanContextEnv)
 
 	dockerEnv := c.Env()
 	qodanaCloudUploadToken := c.QodanaUploadToken()

internal/core/corescan/env_test.go

@@ -70,13 +70,15 @@ func Test_ExtractEnvironmentVariables(t *testing.T) {
 	}
 
 	for _, tc := range []struct {
-		ci                string
-		variables         map[string]string
-		jobUrlExpected    string
-		envExpected       string
-		remoteUrlExpected string
-		revisionExpected  string
-		branchExpected    string
+		ci                    string
+		variables             map[string]string
+		jobUrlExpected        string
+		envExpected           string
+		remoteUrlExpected     string
+		repositoryUrlExpected string
+		revisionExpected      string
+		branchExpected        string
+		gitEnv                qdenv.GitEnv
 	}{
 		{
 			ci:          "no CI detected",
@@ -213,6 +215,23 @@ func Test_ExtractEnvironmentVariables(t *testing.T) {
 			envExpected:    fmt.Sprintf("bitbucket:%s", version.Version),
 			jobUrlExpected: "https://bitbucket.org/sa/entrypoint/pipelines/results/123456789",
 		},
+		{
+			ci: "local-git",
+			gitEnv: qdenv.GitEnv{
+				RemoteUrl:     "https://qodana.jetbrains.com/never-gonna-give-you-up",
+				RepositoryUrl: "https://qodana.jetbrains.com/never-gonna-give-you-up",
+				Revision:      revisionExpected,
+				Branch:        branchExpected,
+			},
+			variables: map[string]string{
+				qdenv.QodanaEnv: "local-git",
+			},
+			envExpected:           "local-git",
+			remoteUrlExpected:     "https://qodana.jetbrains.com/never-gonna-give-you-up",
+			repositoryUrlExpected: "https://qodana.jetbrains.com/never-gonna-give-you-up",
+			revisionExpected:      revisionExpected,
+			branchExpected:        branchExpected,
+		},
 	} {
 		t.Run(
 			tc.ci, func(t *testing.T) {
@@ -246,7 +265,7 @@ func Test_ExtractEnvironmentVariables(t *testing.T) {
 						environment.name, func(t *testing.T) {
 							qdenv.InitializeQodanaGlobalEnv(qdenv.EmptyEnvProvider())
 
-							qdenv.ExtractQodanaEnvironment(environment.set)
+							qdenv.ExtractQodanaEnvironment(tc.gitEnv, environment.set)
 							currentQodanaEnv := environment.get(qdenv.QodanaEnv)
 							if currentQodanaEnv != tc.envExpected {
 								t.Errorf("%s: Expected %s, got %s", environment.name, tc.envExpected, currentQodanaEnv)
@@ -267,6 +286,14 @@ func Test_ExtractEnvironmentVariables(t *testing.T) {
 									environment.get(qdenv.QodanaRemoteUrl),
 								)
 							}
+							if environment.get(qdenv.QodanaRepoUrl) != tc.repositoryUrlExpected {
+								t.Errorf(
+									"%s: Expected %s, got %s",
+									environment.name,
+									tc.repositoryUrlExpected,
+									environment.get(qdenv.QodanaRepoUrl),
+								)
+							}
 							if environment.get(qdenv.QodanaRevision) != tc.revisionExpected {
 								t.Errorf(
 									"%s: Expected %s, got %s",

internal/core/startup/prepare.go

@@ -116,7 +116,7 @@ func prepareLocalIdeSettingsAndGetQodanaCloudUploadToken(
 ) (product.Product, string) {
 	prod := product.GuessProduct(ideDir, commonCtx.Analyzer)
 
-	qdenv.ExtractQodanaEnvironment(qdenv.SetEnv)
+	qdenv.ExtractQodanaEnvironment(git.GetGitEnv(commonCtx.RepositoryRoot, commonCtx.LogDir()), qdenv.SetEnv)
 	isTokenRequired := tokenloader.IsCloudTokenRequired(commonCtx)
 	token := tokenloader.LoadCloudUploadToken(commonCtx, false, isTokenRequired, true)
 	cloud.SetupLicenseToken(token)

internal/platform/git/env.go

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2021-2024 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package git
+
+import (
+	"strings"
+
+	"github.com/JetBrains/qodana-cli/internal/platform/qdenv"
+)
+
+func GetGitEnv(gitRoot string, logDir string) qdenv.GitEnv {
+	var env = &qdenv.GitEnv{}
+	remUrl, err := RemoteUrl(gitRoot, logDir)
+	if err == nil {
+		env.RemoteUrl = remUrl
+		if strings.HasPrefix(remUrl, "https://") {
+			env.RepositoryUrl = remUrl
+		}
+	}
+	brnch, err := Branch(gitRoot, logDir)
+	if err == nil {
+		env.Branch = brnch
+	}
+	revisions := Revisions(gitRoot)
+	if len(revisions) > 0 {
+		env.Revision = revisions[len(revisions)-1]
+	}
+	return *env
+}

internal/platform/qdenv/qdenv.go

@@ -32,6 +32,7 @@ const (
 	// QodanaLicenseOnlyToken !!! QODANA_LICENSE_ONLY_TOKEN is accessed only by env !!!
 	QodanaLicenseOnlyToken        = "QODANA_LICENSE_ONLY_TOKEN"
 	QodanaRemoteUrl               = "QODANA_REMOTE_URL"
+	QodanaRepoUrl                 = "QODANA_REPO_URL"
 	QodanaDockerEnv               = "QODANA_DOCKER"
 	QodanaToolEnv                 = "QODANA_TOOL"
 	QodanaConfEnv                 = "QODANA_CONF"
@@ -64,6 +65,14 @@ const (
 	QodanaToken       = "QODANA_TOKEN"
 )
 
+// GitEnv contains information about the current git repository.
+type GitEnv struct {
+	RemoteUrl     string
+	RepositoryUrl string
+	Branch        string
+	Revision      string
+}
+
 type qodanaGlobalEnv struct {
 	env map[string]string
 }
@@ -138,7 +147,7 @@ func IsContainer() bool {
 }
 
 // ExtractQodanaEnvironment extracts Qodana environment variables from the current environment.
-func ExtractQodanaEnvironment(setEnvironmentFunc func(string, string)) {
+func ExtractQodanaEnvironment(gitEnv GitEnv, setEnvironmentFunc func(string, string)) {
 	if license := os.Getenv(QodanaLicense); license != "" {
 		setEnvironmentFunc(QodanaLicense, license)
 	}
@@ -178,9 +187,31 @@ func ExtractQodanaEnvironment(setEnvironmentFunc func(string, string)) {
 		qEnv = "bitbucket"
 		setEnvironmentFunc(QodanaJobUrl, GetBitBucketJobUrl())
 	}
+	setDefaultQodanaGitEnvironment(gitEnv, setEnvironmentFunc)
 	setEnvironmentFunc(QodanaEnv, fmt.Sprintf("%s:%s", qEnv, version.Version))
 }
 
+func setDefaultQodanaGitEnvironment(gitEnv GitEnv, setEnvironmentFunc func(string, string)) {
+	if remoteUrl := os.Getenv(QodanaRemoteUrl); remoteUrl == "" {
+		if gitEnv.RemoteUrl != "" {
+			setEnvironmentFunc(QodanaRemoteUrl, gitEnv.RemoteUrl)
+		}
+		if gitEnv.RepositoryUrl != "" {
+			setEnvironmentFunc(QodanaRepoUrl, gitEnv.RepositoryUrl)
+		}
+	}
+	if branch := os.Getenv(QodanaBranch); branch == "" {
+		if gitEnv.Branch != "" {
+			setEnvironmentFunc(QodanaBranch, gitEnv.Branch)
+		}
+	}
+	if revision := os.Getenv(QodanaRevision); revision == "" {
+		if gitEnv.Revision != "" {
+			setEnvironmentFunc(QodanaRevision, gitEnv.Revision)
+		}
+	}
+}
+
 func GetCIName(ci *cienvironment.CiEnvironment) string {
 	return strings.ReplaceAll(strings.ToLower(ci.Name), " ", "-")
 }