Add squash option (#719)

* feat: add squash_option to project resource

* Bump github.com/xanzy/go-gitlab from 0.50.0 to 0.50.4

Bumps [github.com/xanzy/go-gitlab](https://github.com/xanzy/go-gitlab) from 0.50.0 to 0.50.4.
- [Release notes](https://github.com/xanzy/go-gitlab/releases)
- [Changelog](https://github.com/xanzy/go-gitlab/blob/master/releases_test.go)
- [Commits](xanzy/go-gitlab@v0.50.0...v0.50.4)

---
updated-dependencies:
- dependency-name: github.com/xanzy/go-gitlab
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* fix: check change of SquashOption

* docs: add valid options to squash_option

* test: add unit test for squash_option

* fix: change squash_option default value

* Add data source and make test check the change in the config

* add missing arguments for bump

* fix

* fix

* conflicts

* fmt

* convert types

* bump to v0.51.0

* fmt

* fix

* make linter happy

* bump to 0.51.1

* fix

* restore previous concept

* fix test

* fix test

* fix?

* fix typo in mapping

* fix tests

* add validation

* fmt

Co-authored-by: KoLiBer <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 3 people

docs/resources/project.md

@@ -91,6 +91,8 @@ consult the [gitlab documentation](https://docs.gitlab.com/ee/user/project/repos
 
 * `initialize_with_readme` - (Optional) Create main branch with first commit containing a README.md file.
 
+* `squash_option` - (Optional) Squash commits when merge request. Valid values are `never`, `always`, `default_on`, or `default_off`. The default value is `default_off`.
+
 * `packages_enabled` - (Optional) Enable packages repository for the project.
 
 * `push_rules` (Optional) Push rules for the project (documented below).

gitlab/resource_gitlab_project.go

@@ -162,6 +162,12 @@ var resourceGitLabProjectSchema = map[string]*schema.Schema{
 		Type:     schema.TypeBool,
 		Optional: true,
 	},
+	"squash_option": {
+		Type:         schema.TypeString,
+		Optional:     true,
+		Default:      "default_off",
+		ValidateFunc: validation.StringInSlice([]string{"never", "default_on", "always", "default_off"}, true),
+	},
 	"remove_source_branch_after_merge": {
 		Type:     schema.TypeBool,
 		Optional: true,
@@ -332,6 +338,7 @@ func resourceGitlabProjectSetToState(d *schema.ResourceData, project *gitlab.Pro
 		return err
 	}
 	d.Set("archived", project.Archived)
+	d.Set("squash_option", project.SquashOption)
 	d.Set("remove_source_branch_after_merge", project.RemoveSourceBranchAfterMerge)
 	d.Set("packages_enabled", project.PackagesEnabled)
 	d.Set("pages_access_level", string(project.PagesAccessLevel))
@@ -364,6 +371,7 @@ func resourceGitlabProjectCreate(d *schema.ResourceData, meta interface{}) error
 		OnlyAllowMergeIfAllDiscussionsAreResolved: gitlab.Bool(d.Get("only_allow_merge_if_all_discussions_are_resolved").(bool)),
 		AllowMergeOnSkippedPipeline:               gitlab.Bool(d.Get("allow_merge_on_skipped_pipeline").(bool)),
 		SharedRunnersEnabled:                      gitlab.Bool(d.Get("shared_runners_enabled").(bool)),
+		SquashOption:                              stringToSquashOptionValue(d.Get("squash_option").(string)),
 		RemoveSourceBranchAfterMerge:              gitlab.Bool(d.Get("remove_source_branch_after_merge").(bool)),
 		PackagesEnabled:                           gitlab.Bool(d.Get("packages_enabled").(bool)),
 		Mirror:                                    gitlab.Bool(d.Get("mirror").(bool)),
@@ -671,6 +679,10 @@ func resourceGitlabProjectUpdate(d *schema.ResourceData, meta interface{}) error
 		options.LFSEnabled = gitlab.Bool(d.Get("lfs_enabled").(bool))
 	}
 
+	if d.HasChange("squash_option") {
+		options.SquashOption = stringToSquashOptionValue(d.Get("squash_option").(string))
+	}
+
 	if d.HasChange("remove_source_branch_after_merge") {
 		options.RemoveSourceBranchAfterMerge = gitlab.Bool(d.Get("remove_source_branch_after_merge").(bool))
 	}

gitlab/resource_gitlab_project_test.go

@@ -44,12 +44,13 @@ func TestAccGitlabProject_basic(t *testing.T) {
 		MergeMethod:                      gitlab.FastForwardMerge,
 		OnlyAllowMergeIfPipelineSucceeds: true,
 		OnlyAllowMergeIfAllDiscussionsAreResolved: true,
-		AllowMergeOnSkippedPipeline:               false,
-		Archived:                                  false, // needless, but let's make this explicit
-		PackagesEnabled:                           true,
-		PagesAccessLevel:                          gitlab.PublicAccessControl,
-		BuildCoverageRegex:                        "foo",
-		CIConfigPath:                              ".gitlab-ci.yml@mynamespace/myproject",
+		SquashOption:                gitlab.SquashOptionDefaultOff,
+		AllowMergeOnSkippedPipeline: false,
+		Archived:                    false, // needless, but let's make this explicit
+		PackagesEnabled:             true,
+		PagesAccessLevel:            gitlab.PublicAccessControl,
+		BuildCoverageRegex:          "foo",
+		CIConfigPath:                ".gitlab-ci.yml@mynamespace/myproject",
 	}
 
 	defaultsMainBranch = defaults
@@ -89,11 +90,12 @@ func TestAccGitlabProject_basic(t *testing.T) {
 						MergeMethod:                      gitlab.FastForwardMerge,
 						OnlyAllowMergeIfPipelineSucceeds: true,
 						OnlyAllowMergeIfAllDiscussionsAreResolved: true,
-						AllowMergeOnSkippedPipeline:               true,
-						Archived:                                  true,
-						PackagesEnabled:                           false,
-						PagesAccessLevel:                          gitlab.DisabledAccessControl,
-						BuildCoverageRegex:                        "bar",
+						SquashOption:                gitlab.SquashOptionDefaultOn,
+						AllowMergeOnSkippedPipeline: true,
+						Archived:                    true,
+						PackagesEnabled:             false,
+						PagesAccessLevel:            gitlab.DisabledAccessControl,
+						BuildCoverageRegex:          "bar",
 					}, &received),
 				),
 			},
@@ -362,6 +364,7 @@ func TestAccGitlabProject_willError(t *testing.T) {
 		MergeMethod:                      gitlab.FastForwardMerge,
 		OnlyAllowMergeIfPipelineSucceeds: true,
 		OnlyAllowMergeIfAllDiscussionsAreResolved: true,
+		SquashOption:       gitlab.SquashOptionDefaultOff,
 		PackagesEnabled:    true,
 		PagesAccessLevel:   gitlab.PublicAccessControl,
 		BuildCoverageRegex: "foo",
@@ -465,6 +468,7 @@ func TestAccGitlabProject_transfer(t *testing.T) {
 		MergeMethod:                      gitlab.NoFastForwardMerge,
 		OnlyAllowMergeIfPipelineSucceeds: false,
 		OnlyAllowMergeIfAllDiscussionsAreResolved: false,
+		SquashOption:       gitlab.SquashOptionDefaultOff,
 		PackagesEnabled:    true,
 		PagesAccessLevel:   gitlab.PrivateAccessControl,
 		BuildCoverageRegex: "foo",
@@ -999,6 +1003,7 @@ resource "gitlab_project" "foo" {
   merge_method = "ff"
   only_allow_merge_if_pipeline_succeeds = true
   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
@@ -1056,6 +1061,7 @@ resource "gitlab_project" "foo" {
   merge_method = "ff"
   only_allow_merge_if_pipeline_succeeds = true
   only_allow_merge_if_all_discussions_are_resolved = true
+  squash_option = "default_on"
   allow_merge_on_skipped_pipeline = true
 
   request_access_enabled = false

gitlab/util.go

@@ -143,6 +143,21 @@ func stringToMergeMethod(s string) *gitlab.MergeMethodValue {
 	return &value
 }
 
+func stringToSquashOptionValue(s string) *gitlab.SquashOptionValue {
+	lookup := map[string]gitlab.SquashOptionValue{
+		"never":       gitlab.SquashOptionNever,
+		"always":      gitlab.SquashOptionAlways,
+		"default_on":  gitlab.SquashOptionDefaultOn,
+		"default_off": gitlab.SquashOptionDefaultOff,
+	}
+
+	value, ok := lookup[s]
+	if !ok {
+		return nil
+	}
+	return &value
+}
+
 func stringToAccessControlValue(s string) *gitlab.AccessControlValue {
 	lookup := map[string]gitlab.AccessControlValue{
 		"disabled": gitlab.DisabledAccessControl,