Merge pull request #1036 from PatrickRice-KSC/deprecate-branch-coverage

Deprecate branch coverage

Author: timofurrer

.gitpod.yml

@@ -1,6 +1,11 @@
 image: gitpod/workspace-go
 tasks:
-  - init: go get
+# Retrieve our go dependencies. Also inject several vscode settings that are specifically helpful to a GitPod environment and not needed when opening the repo locally.
+# The reason the settings are copied to a temp file and then moved is that applying the jq string directly to settings.json results in a blank file.
+  - init: |
+      go get
+      cat .vscode/settings.json | jq '. + {"terminal.integrated.lineHeight": 1.0,"terminal.integrated.letterSpacing": 1.0,"terminal.integrated.scrollback": 5000}'  > .vscode/temp.json
+      mv .vscode/temp.json .vscode/settings.json
   - name: Start acceptance Test Environment
     command: make testacc-up
     openMode: split-right

.vscode/settings.json

@@ -1,8 +1,8 @@
 {
-    "go.testEnvVars": {
-        "TF_ACC": "1",
-        "GITLAB_TOKEN": "ACCTEST1234567890123",
-        "GITLAB_BASE_URL": "http://127.0.0.1:8080"
-    },
-    "go.testFlags": ["-count=1", "-v"]
-}
+  "go.testEnvVars": {
+    "TF_ACC": "1",
+    "GITLAB_TOKEN": "ACCTEST1234567890123",
+    "GITLAB_BASE_URL": "http://127.0.0.1:8080"
+  },
+  "go.testFlags": ["-count=1", "-v", "-timeout=30m"]
+}

docs/resources/project.md

@@ -81,7 +81,7 @@ resource "gitlab_project" "peters_repo" {
 - `auto_devops_deploy_strategy` (String) Auto Deploy strategy. Valid values are `continuous`, `manual`, `timed_incremental`.
 - `auto_devops_enabled` (Boolean) Enable Auto DevOps for this project.
 - `autoclose_referenced_issues` (Boolean) Set whether auto-closing referenced issues on default branch.
-- `build_coverage_regex` (String) Test coverage parsing for the project.
+- `build_coverage_regex` (String, Deprecated) Test coverage parsing for the project. This is deprecated feature in GitLab 15.0.
 - `build_git_strategy` (String) The Git strategy. Defaults to fetch.
 - `build_timeout` (Number) The maximum amount of time, in seconds, that a job can run.
 - `builds_access_level` (String) Set the builds access level. Valid values are `disabled`, `private`, `enabled`.

internal/provider/resource_gitlab_project.go

@@ -367,9 +367,10 @@ var resourceGitLabProjectSchema = map[string]*schema.Schema{
 		RequiredWith: []string{"import_url"},
 	},
 	"build_coverage_regex": {
-		Description: "Test coverage parsing for the project.",
+		Description: "Test coverage parsing for the project. This is deprecated feature in GitLab 15.0.",
 		Type:        schema.TypeString,
 		Optional:    true,
+		Deprecated:  "build_coverage_regex is removed in GitLab 15.0.",
 	},
 	"issues_template": {
 		Description: "Sets the template for new issues in the project.",
@@ -714,7 +715,6 @@ func resourceGitlabProjectSetToState(ctx context.Context, client *gitlab.Client,
 	d.Set("mirror_trigger_builds", project.MirrorTriggerBuilds)
 	d.Set("mirror_overwrites_diverged_branches", project.MirrorOverwritesDivergedBranches)
 	d.Set("only_mirror_protected_branches", project.OnlyMirrorProtectedBranches)
-	d.Set("build_coverage_regex", project.BuildCoverageRegex)
 	d.Set("issues_template", project.IssuesTemplate)
 	d.Set("merge_requests_template", project.MergeRequestsTemplate)
 	d.Set("ci_config_path", project.CIConfigPath)
@@ -752,6 +752,10 @@ func resourceGitlabProjectSetToState(ctx context.Context, client *gitlab.Client,
 	d.Set("wiki_access_level", string(project.WikiAccessLevel))
 	d.Set("squash_commit_template", project.SquashCommitTemplate)
 	d.Set("merge_commit_template", project.MergeCommitTemplate)
+
+	//Note: This field is deprecated and will always be an empty string starting in GitLab 15.0.
+	d.Set("build_coverage_regex", project.BuildCoverageRegex)
+
 	return nil
 }
 
@@ -780,11 +784,14 @@ func resourceGitlabProjectCreate(ctx context.Context, d *schema.ResourceData, me
 		PrintingMergeRequestLinkEnabled:           gitlab.Bool(d.Get("printing_merge_request_link_enabled").(bool)),
 		Mirror:                                    gitlab.Bool(d.Get("mirror").(bool)),
 		MirrorTriggerBuilds:                       gitlab.Bool(d.Get("mirror_trigger_builds").(bool)),
-		BuildCoverageRegex:                        gitlab.String(d.Get("build_coverage_regex").(string)),
 		CIConfigPath:                              gitlab.String(d.Get("ci_config_path").(string)),
 		CIForwardDeploymentEnabled:                gitlab.Bool(d.Get("ci_forward_deployment_enabled").(bool)),
 	}
 
+	if v, ok := d.GetOk("build_coverage_regex"); ok {
+		options.BuildCoverageRegex = gitlab.String(v.(string))
+	}
+
 	if v, ok := d.GetOk("path"); ok {
 		options.Path = gitlab.String(v.(string))
 	}
@@ -1312,7 +1319,7 @@ func resourceGitlabProjectUpdate(ctx context.Context, d *schema.ResourceData, me
 	}
 
 	if d.HasChange("build_coverage_regex") {
-		options.BuildCoverageRegex = gitlab.String(d.Get("build_coverage_regex").(string))
+		options.IssuesTemplate = gitlab.String(d.Get("build_coverage_regex").(string))
 	}
 
 	if d.HasChange("issues_template") {

internal/provider/resource_gitlab_project_test.go

@@ -77,7 +77,6 @@ func TestAccGitlabProject_basic(t *testing.T) {
 		PackagesEnabled:                 true,
 		PrintingMergeRequestLinkEnabled: true,
 		PagesAccessLevel:                gitlab.PublicAccessControl,
-		BuildCoverageRegex:              "foo",
 		IssuesTemplate:                  "",
 		MergeRequestsTemplate:           "",
 		CIConfigPath:                    ".gitlab-ci.yml@mynamespace/myproject",
@@ -158,7 +157,6 @@ func TestAccGitlabProject_basic(t *testing.T) {
 						Archived:                       true,
 						PackagesEnabled:                false,
 						PagesAccessLevel:               gitlab.DisabledAccessControl,
-						BuildCoverageRegex:             "bar",
 						CIForwardDeploymentEnabled:     false,
 						ResolveOutdatedDiffDiscussions: false,
 						AnalyticsAccessLevel:           gitlab.DisabledAccessControl,
@@ -736,7 +734,6 @@ func TestAccGitlabProject_transfer(t *testing.T) {
 		PackagesEnabled:                 true,
 		PrintingMergeRequestLinkEnabled: true,
 		PagesAccessLevel:                gitlab.PrivateAccessControl,
-		BuildCoverageRegex:              "foo",
 		CIForwardDeploymentEnabled:      true,
 	}
 
@@ -1148,6 +1145,38 @@ func TestAccGitlabProject_containerExpirationPolicy(t *testing.T) {
 	})
 }
 
+func TestAccGitlabProject_DeprecatedBuildCoverageRegex(t *testing.T) {
+	var received gitlab.Project
+	rInt := acctest.RandInt()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
+		CheckDestroy:      testAccCheckGitlabProjectDestroy,
+		Steps: []resource.TestStep{
+			{
+				SkipFunc: isGitLabVersionLessThan(context.Background(), testGitlabClient, "15.0"),
+				Config: fmt.Sprintf(`
+					resource "gitlab_project" "this" {
+						name = "foo-%d"
+						visibility_level = "public"
+
+						build_coverage_regex = "helloWorld"
+					}`, rInt),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckGitlabProjectExists("gitlab_project.this", &received),
+				),
+			},
+			{
+				SkipFunc:          isGitLabVersionLessThan(context.Background(), testGitlabClient, "15.0"),
+				ResourceName:      "gitlab_project.this",
+				ImportState:       true,
+				ImportStateVerify: true,
+			},
+		},
+	})
+}
+
 func testAccCheckGitlabProjectExists(n string, project *gitlab.Project) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		var err error
@@ -1359,7 +1388,6 @@ resource "gitlab_project" "foo" {
   # So that acceptance tests can be run in a gitlab organization
   # with no billing
   visibility_level = "public"
-  build_coverage_regex = "foo"
 }
 	`, rInt, rInt, rInt)
 }
@@ -1415,7 +1443,6 @@ resource "gitlab_project" "foo" {
   # So that acceptance tests can be run in a gitlab organization
   # with no billing
   visibility_level = "public"
-  build_coverage_regex = "foo"
 }
 
 resource "gitlab_project_variable" "foo" {
@@ -1449,7 +1476,6 @@ resource "gitlab_project" "foo" {
   # So that acceptance tests can be run in a gitlab organization
   # with no billing
   visibility_level = "public"
-  build_coverage_regex = "foo"
 }
 
 resource "gitlab_project_variable" "foo" {
@@ -1489,7 +1515,6 @@ resource "gitlab_project" "foo" {
   only_allow_merge_if_all_discussions_are_resolved = true
   squash_option = "default_off"
   pages_access_level = "public"
-  build_coverage_regex = "foo"
   allow_merge_on_skipped_pipeline = false
   ci_config_path = ".gitlab-ci.yml@mynamespace/myproject"
   resolve_outdated_diff_discussions = true
@@ -1589,7 +1614,6 @@ resource "gitlab_project" "foo" {
   archived = true
   packages_enabled = false
   pages_access_level = "disabled"
-  build_coverage_regex = "bar"
   ci_forward_deployment_enabled = false
   merge_pipelines_enabled = false
   merge_trains_enabled = false
@@ -1929,7 +1953,6 @@ resource "gitlab_project" "foo" {
   only_allow_merge_if_all_discussions_are_resolved = true
   squash_option = "default_off"
   pages_access_level = "public"
-  build_coverage_regex = "foo"
   allow_merge_on_skipped_pipeline = false
   ci_config_path = ".gitlab-ci.yml@mynamespace/myproject"
   resolve_outdated_diff_discussions = true