Add managed license resources and tests (#700)

* Add managed license resources and tests

* Add documentation for the managed_license resource

* Update to v2 schema using context

This involves several updates: 1. Update the schema.Resource to the "Context" method; 2. Pass in context to each of the functions and update returns to "diagnostic" type; 3. Pass in context to each of the client calls.

* Add import statement and update tests accordingly

In addition, I added the import statement the documentation and renamed the documentation filename to remove the "gitlab_" from the front which now matches the convention of the remainder of the documentation.

* Pass through updating documentation to new standards and using new SkipFunc

* Fixed several issues with tests. Implemented specific importer methods.

The importer passthrough method seemed to break on the multi-ID needed for the project:license pair.

* Rename license variable from "id" to "licenseId"

* Update import to use StatePassthroughContext

This also required updating the CRUD methods to accept a 2 part string and parse out the ID

* Remove dead code.

* Remove random license name

* Apply suggestion re: removing from state if it doesn't exist in upsteam

Co-authored-by: Adam Snyder <[email protected]>

* Add callout re: Ultimate subscription and comments to the import.sh

* Properly generate documentation for pr-lint.

* Added second newline and re-generated documentation.

Co-authored-by: Adam Snyder <[email protected]>

Author: RicePatrick

docs/resources/managed_license.md

@@ -0,0 +1,54 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_managed_license Resource - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  This resource allows you to add rules for managing licenses on a project.
+  For additional information, please see the gitlab documentation https://docs.gitlab.com/ee/user/compliance/license_compliance/.
+  ~> Using this resource requires an active gitlab ultimate https://about.gitlab.com/pricing/subscription.
+---
+
+# gitlab_managed_license (Resource)
+
+This resource allows you to add rules for managing licenses on a project.
+For additional information, please see the [gitlab documentation](https://docs.gitlab.com/ee/user/compliance/license_compliance/).
+
+~> Using this resource requires an active [gitlab ultimate](https://about.gitlab.com/pricing/)subscription.
+
+## Example Usage
+
+```terraform
+resource "gitlab_project" "foo" {
+  name             = "example project"
+  description      = "Lorem Ipsum"
+  visibility_level = "public"
+}
+
+resource "gitlab_managed_license" "mit" {
+  project         = gitlab_project.foo.id
+  name            = "MIT license"
+  approval_status = "approved"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **approval_status** (String) Whether the license is approved or not. Only 'approved' or 'blacklisted' allowed.
+- **name** (String) The name of the managed license (I.e., 'Apache License 2.0' or 'MIT license')
+- **project** (String) The ID of the project under which the managed license will be created.
+
+### Optional
+
+- **id** (String) The ID of this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# You can import this resource with an id made up of `{project-id}:{license-id}`, e.g.
+terraform import gitlab_managed_license.foo 1:2
+```

examples/resources/gitlab_managed_license/import.sh

@@ -0,0 +1,2 @@
+# You can import this resource with an id made up of `{project-id}:{license-id}`, e.g.
+terraform import gitlab_managed_license.foo 1:2

examples/resources/gitlab_managed_license/resource.tf

@@ -0,0 +1,11 @@
+resource "gitlab_project" "foo" {
+  name             = "example project"
+  description      = "Lorem Ipsum"
+  visibility_level = "public"
+}
+
+resource "gitlab_managed_license" "mit" {
+  project         = gitlab_project.foo.id
+  name            = "MIT license"
+  approval_status = "approved"
+}

gitlab/provider.go

@@ -76,6 +76,7 @@ func Provider() *schema.Provider {
 			"gitlab_project":                    resourceGitlabProject(),
 			"gitlab_project_custom_attribute":   resourceGitlabProjectCustomAttribute(),
 			"gitlab_label":                      resourceGitlabLabel(),
+			"gitlab_managed_license":            resourceGitlabManagedLicense(),
 			"gitlab_group_label":                resourceGitlabGroupLabel(),
 			"gitlab_pipeline_schedule":          resourceGitlabPipelineSchedule(),
 			"gitlab_pipeline_schedule_variable": resourceGitlabPipelineScheduleVariable(),

gitlab/resource_gitlab_managed_license.go

@@ -0,0 +1,172 @@
+package gitlab
+
+import (
+	"context"
+	"fmt"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
+	"github.com/xanzy/go-gitlab"
+	"log"
+	"strconv"
+)
+
+func resourceGitlabManagedLicense() *schema.Resource {
+	return &schema.Resource{
+		Description: "This resource allows you to add rules for managing licenses on a project.\n" +
+			"For additional information, please see the " +
+			"[gitlab documentation](https://docs.gitlab.com/ee/user/compliance/license_compliance/).\n\n" +
+			"~> Using this resource requires an active [gitlab ultimate](https://about.gitlab.com/pricing/)" +
+			"subscription.",
+
+		CreateContext: resourceGitlabManagedLicenseCreate,
+		ReadContext:   resourceGitlabManagedLicenseRead,
+		UpdateContext: resourceGitlabManagedLicenseUpdate,
+		DeleteContext: resourceGitlabManagedLicenseDelete,
+		Importer: &schema.ResourceImporter{
+			StateContext: schema.ImportStatePassthroughContext,
+		},
+
+		Schema: map[string]*schema.Schema{
+			"project": {
+				Type:        schema.TypeString,
+				Required:    true,
+				ForceNew:    true,
+				Description: "The ID of the project under which the managed license will be created.",
+			},
+			"name": {
+				Type:     schema.TypeString,
+				Required: true,
+				// GitLab's edit API doesn't allow us to edit the name, only
+				// the approval status.
+				ForceNew:    true,
+				Description: "The name of the managed license (I.e., 'Apache License 2.0' or 'MIT license')",
+			},
+			"approval_status": {
+				Type:         schema.TypeString,
+				Required:     true,
+				ForceNew:     false,
+				ValidateFunc: validation.StringInSlice([]string{"approved", "blacklisted"}, true),
+				Description:  "Whether the license is approved or not. Only 'approved' or 'blacklisted' allowed.",
+			},
+		},
+	}
+}
+
+func resourceGitlabManagedLicenseCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project := d.Get("project").(string)
+
+	options := &gitlab.AddManagedLicenseOptions{
+		Name:           gitlab.String(d.Get("name").(string)),
+		ApprovalStatus: stringToApprovalStatus(d.Get("approval_status").(string)),
+	}
+
+	log.Printf("[DEBUG] create gitlab Managed License on Project %s, with Name %s", project, *options.Name)
+
+	addManagedLicense, _, err := client.ManagedLicenses.AddManagedLicense(project, options, gitlab.WithContext(ctx))
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	licenseId := strconv.Itoa(addManagedLicense.ID)
+	d.SetId(buildTwoPartID(&project, &licenseId))
+
+	return resourceGitlabManagedLicenseRead(ctx, d, meta)
+}
+
+func resourceGitlabManagedLicenseDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project, licenseId, err := projectIdAndLicenseIdFromId(d.Id())
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	log.Printf("[DEBUG] Delete gitlab Managed License %s", d.Id())
+	_, err = client.ManagedLicenses.DeleteManagedLicense(project, licenseId, gitlab.WithContext(ctx))
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("failed to delete managed license %d for projec %s: %w", licenseId, project, err))
+	}
+
+	return nil
+}
+
+func resourceGitlabManagedLicenseRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project, licenseId, err := projectIdAndLicenseIdFromId(d.Id())
+	if err != nil {
+		diag.FromErr(err)
+	}
+
+	log.Printf("[DEBUG] read gitlab Managed License for project/licenseId %s/%d", project, licenseId)
+	license, _, err := client.ManagedLicenses.GetManagedLicense(project, licenseId, gitlab.WithContext(ctx))
+	if err != nil {
+		if is404(err) {
+			log.Printf("[DEBUG] Managed License %s:%d no longer exists and is being removed from state", project, licenseId)
+			d.SetId("")
+			return nil
+		}
+		return diag.FromErr(err)
+	}
+
+	d.Set("project", project)
+	d.Set("name", license.Name)
+	d.Set("approval_status", license.ApprovalStatus)
+
+	return nil
+}
+
+func resourceGitlabManagedLicenseUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project, licenseId, err := projectIdAndLicenseIdFromId(d.Id())
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	opts := &gitlab.EditManagedLicenceOptions{
+		ApprovalStatus: stringToApprovalStatus(d.Get("approval_status").(string)),
+	}
+
+	if d.HasChange("approval_status") {
+		opts.ApprovalStatus = stringToApprovalStatus(d.Get("approval_status").(string))
+	}
+
+	log.Printf("[DEBUG] update gitlab Managed License %s", d.Id())
+	_, _, err = client.ManagedLicenses.EditManagedLicense(project, licenseId, opts, gitlab.WithContext(ctx))
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	licenseIdStr := strconv.Itoa(licenseId)
+	d.SetId(buildTwoPartID(&project, &licenseIdStr))
+
+	return resourceGitlabManagedLicenseRead(ctx, d, meta)
+}
+
+// Convert the incoming string into the proper constant value for passing into the API.
+func stringToApprovalStatus(s string) *gitlab.LicenseApprovalStatusValue {
+	lookup := map[string]gitlab.LicenseApprovalStatusValue{
+		"approved":    gitlab.LicenseApproved,
+		"blacklisted": gitlab.LicenseBlacklisted,
+	}
+
+	value, ok := lookup[s]
+	if !ok {
+		return nil
+	}
+	return &value
+}
+
+func projectIdAndLicenseIdFromId(id string) (string, int, error) {
+	projectId, id, err := parseTwoPartID(id)
+	if err != nil {
+		return "", 0, err
+	}
+
+	licenseId, err := strconv.Atoi(id)
+	if err != nil {
+		return "", 0, err
+	}
+
+	return projectId, licenseId, nil
+}