Merge branch 'master' into 544-rm-vendor

armsnyder · web-flow · commit d54aba7e6cb2 · 2021-02-03T11:47:27.000-08:00
diff --git a/.github/workflows/acceptance-tests.yml b/.github/workflows/acceptance-tests.yml
@@ -15,18 +15,11 @@ jobs:
     - name: Check out code repository source code
       uses: actions/checkout@v2
 
-    # https://help.github.com/en/actions/reference/workflow-commands-for-github-actions
-    - name: Set build variables
-      run: |
-        echo "MAKE_TARGET=testacc" >> $GITHUB_ENV
-        echo "GO111MODULE=on" >> $GITHUB_ENV
-        echo "GITLAB_TOKEN=20char-testing-token" >> $GITHUB_ENV
-        echo "GITLAB_BASE_URL=http://127.0.0.1:8080/api/v4" >> $GITHUB_ENV
+    - name: Start Gitlab
+      run: make testacc-up
 
-    - name: Start Gitlab and run acceptance tests
-      run: |
-        bash scripts/start-gitlab.sh
-        make $MAKE_TARGET
+    - name: Run acceptance tests
+      run: make testacc
 
   acceptance-ee:
     timeout-minutes: 60
@@ -47,20 +40,11 @@ jobs:
         openssl version
         mkdir license
         [[ -n "${{ secrets.LICENSE_ENCRYPTION_PASSWORD }}" ]] && echo decrypt
-        [[ -n "${{ secrets.LICENSE_ENCRYPTION_PASSWORD }}" ]] && openssl enc  -d -aes-256-cbc -pbkdf2 -iter 20000 -in Gitlab-license.encrypted -out license/Gitlab-license.txt -pass "pass:${{ secrets.LICENSE_ENCRYPTION_PASSWORD }}"
-        chmod 666 license/Gitlab-license.txt || true
-        echo "GITLAB_LICENSE_FILE=Gitlab-license.txt" >> $GITHUB_ENV
+        [[ -n "${{ secrets.LICENSE_ENCRYPTION_PASSWORD }}" ]] && openssl enc  -d -aes-256-cbc -pbkdf2 -iter 20000 -in Gitlab-license.encrypted -out Gitlab-license.txt -pass "pass:${{ secrets.LICENSE_ENCRYPTION_PASSWORD }}"
+        chmod 666 Gitlab-license.txt || true
 
-    # https://help.github.com/en/actions/reference/workflow-commands-for-github-actions
-    - name: Set build variables
-      run: |
-        echo "MAKE_TARGET=testacc" >> $GITHUB_ENV
-        echo "GO111MODULE=on" >> $GITHUB_ENV
-        echo "GITLAB_TOKEN=20char-testing-token" >> $GITHUB_ENV
-        echo "GITLAB_BASE_URL=http://127.0.0.1:8080/api/v4" >> $GITHUB_ENV
-        echo "TF_LOG=DEBUG" >> $GITHUB_ENV
+    - name: Start Gitlab
+      run: make testacc-up
 
-    - name: Start Gitlab and run acceptance tests
-      run: |
-        bash scripts/start-gitlab.sh
-        make $MAKE_TARGET
+    - name: Run acceptance tests
+      run: make testacc
diff --git a/.gitignore b/.gitignore
@@ -32,3 +32,4 @@ website/vendor
 !command/test-fixtures/**/.terraform/
 
 license/*
+Gitlab-license.txt
diff --git a/GNUmakefile b/GNUmakefile
@@ -1,6 +1,12 @@
 TEST?=./gitlab
+SERVICE?=gitlab-ce
+GITLAB_TOKEN?=ACCTEST
+GITLAB_BASE_URL?=http://127.0.0.1:8080/api/v4
 GOFMT_FILES?=$$(find . -name '*.go' |grep -v vendor)
-PKG_NAME=gitlab
+
+ifdef RUN
+TESTARGS += -test.run $(RUN)
+endif
 
 default: build
 
@@ -12,14 +18,15 @@ test: fmtcheck
 	echo $(TEST) | \
 		xargs -t -n4 go test $(TESTARGS) -timeout=30s -parallel=4
 
-testacc-prepareenv:
-	MAKE_TARGET=testacc GITLAB_TOKEN=ACCTEST LC_ALL=en_US sh -c "'$(CURDIR)/scripts/start-gitlab.sh'"
+testacc-up:
+	docker-compose up -d $(SERVICE)
+	./scripts/await-healthy.sh
 
-testacc-cleanenv:
-	docker stop gitlab
+testacc-down:
+	docker-compose down
 
 testacc: fmtcheck
-	TF_ACC=1 go test -v $(TEST) $(TESTARGS) -timeout 40m
+	TF_ACC=1 GITLAB_TOKEN=$(GITLAB_TOKEN) GITLAB_BASE_URL=$(GITLAB_BASE_URL) go test -v $(TEST) $(TESTARGS) -timeout 40m
 
 vet:
 	@echo "go vet ."
@@ -39,14 +46,4 @@ fmtcheck:
 errcheck:
 	@sh -c "'$(CURDIR)/scripts/errcheck.sh'"
 
-
-test-compile:
-	@if [ "$(TEST)" = "./..." ]; then \
-		echo "ERROR: Set TEST to a specific package. For example,"; \
-		echo "  make test-compile TEST=./$(PKG_NAME)"; \
-		exit 1; \
-	fi
-	go test -c $(TEST) $(TESTARGS)
-
-.PHONY: build test testacc vet fmt fmtcheck errcheck test-compile
-
+.PHONY: default build test testacc-up testacc-down testacc vet fmt fmtcheck errcheck
diff --git a/README.md b/README.md
@@ -17,61 +17,101 @@ Requirements
 -	[Terraform](https://www.terraform.io/downloads.html) 0.12.x
 -	[Go](https://golang.org/doc/install) >= 1.14 (to build the provider plugin)
 
-Building The Provider
----------------------
+## Developing The Provider
 
-Clone repository to: `$GOPATH/src/github.com/gitlabhq/terraform-provider-gitlab`
+If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.14+ is *required*).
 
-```sh
-$ mkdir -p $GOPATH/src/github.com/gitlabhq; cd $GOPATH/src/github.com/gitlabhq
-$ git clone git@github.com:gitlabhq/terraform-provider-gitlab
-```
+1. Clone the git repository.
 
-Enter the provider directory and build the provider
+   ```sh
+   $ git clone git@github.com:gitlabhq/terraform-provider-gitlab
+   $ cd terraform-provider-gitlab
+   ```
 
-```sh
-$ cd $GOPATH/src/github.com/gitlabhq/terraform-provider-gitlab
-$ make build
-```
+2. Build the provider with `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
 
-Using the provider
-----------------------
+   ```sh
+   $ make build
+   ```
 
-# Developing the Provider
+### Running Tests
 
-If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.14+ is *required*).
+The acceptance tests can run against a Gitlab instance where you have a token with administrator permissions (likely not gitlab.com).
 
-To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
+#### Option 1: Run tests against a local Gitlab container with docker-compose
 
-```sh
-$ make build
-...
-$ $GOPATH/bin/terraform-provider-gitlab
-...
-```
+This option is the easiest and requires [docker-compose](https://docs.docker.com/compose/install/) (version 1.13+) to be installed on your machine.
+
+1. Start the Gitlab container. It will take about 5 minutes for the container to become healthy.
+
+  ```sh
+  $ make testacc-up
+  ```
 
-### Running tests
+2. Run the acceptance tests. The full suite takes 10-20 minutes to run.
 
-The Terraform Provider only has acceptance tests, these can run against a gitlab instance where you have a token with administrator permissions (likely not gitlab.com).
-There is excellent documentation on [how to run gitlab from docker at gitlab.com](https://docs.gitlab.com/omnibus/docker/)
+  ```sh
+  $ make testacc
+  ```
 
-In order to run the full suite of acceptance tests, export the environment variables: 
+3. Stop the Gitlab container.
 
-- `GITLAB_TOKEN` //token for account with admin priviliges
-- `GITLAB_BASE_URL` //URL with api part e.g. `http://localhost:8929/api/v4/`
+  ```sh
+  $ make testacc-down
+  ```
 
-and run `make testacc`.
+#### Option 2: Run tests against your own Gitlab instance
+
+If you have your own hosted Gitlab instance, you can run the tests against it directly.
 
 ```sh
-$ make testacc
+$ make testacc GITLAB_TOKEN=example123 GITLAB_BASE_URL=https://example.com/api/v4
 ```
 
-### Gitlab Community Edition and Gitlab Entreprise Edition
+`GITLAB_TOKEN` must be a valid token for an account with admin privileges.
+
+#### Testing Tips
+
+* **Gitlab Community Edition and Gitlab Enterprise Edition:**
+
+  This module supports both Gitlab CE and Gitlab EE. We run tests on Gitlab EE,
+  but can't run them on pull requests from forks.
+
+  Features that only work on one flavour can use the following helpers as
+  SkipFunc: `isRunningInEE` and `isRunningInCE`. You can see an example of this
+  for [gitlab_project_level_mr_approvals](gitlab/resource_gitlab_project_level_mr_approvals_test.go)
+  tests.
+
+* **Run EE tests:**
+
+  If you have a `Gitlab-license.txt` you can run Gitlab EE, which will enable the full suite of tests:
+
+  ```sh
+  $ make testacc-up SERVICE=gitlab-ee
+  ```
+
+* **Run a single test:**
+
+  You can pass a pattern to the `RUN` variable to run a reduced number of tests. For example:
+
+  ```sh
+  $ make testacc RUN=TestAccGitlabGroup
+  ```
+
+   ...will run all tests for the `gitlab_group` resource.
+
+* **Debug a test in an IDE:**
+
+  First start the Gitlab container with `make testacc-up`.
+  Then run the desired Go test as you would normally from your IDE, but configure your run configuration to set these environment variables:
+
+  ```
+  GITLAB_TOKEN=ACCTEST
+  GITLAB_BASE_URL=http://127.0.0.1:8080/api/v4
+  TF_ACC=1
+  ```
 
-This module supports both Gitlab CE and Gitlab EE. We run tests on Gitlab EE,
-but can't run them on pull requests from forks.
+* **Useful HashiCorp documentation:**
 
-Features that only work on one flavour can use the following helpers as
-SkipFunc: `isRunningInEE` and `isRunningInCE`. You can see an example of this
-for [gitlab_project_push_rules](gitlab/resource_gitlab_project_push_rules_test.go)
-tests.
+  Refer to [HashiCorp's testing guide](https://www.terraform.io/docs/extend/testing/index.html)
+  and [HashiCorp's testing best practices](https://www.terraform.io/docs/extend/best-practices/testing.html).
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,52 @@
+version: '3'
+
+# Acceptance tests depend on a running GitLab instance.
+# Only one of these services should be run at a time.
+services:
+  gitlab-ce:
+    image: gitlab/gitlab-ce
+    restart: always
+    ports:
+      - 8080:80
+    environment:
+      GITLAB_ROOT_PASSWORD: adminadmin
+    labels:
+      terraform-provider-gitlab/owned: ''
+    volumes:
+      - config-ce:/etc/gitlab
+      - logs-ce:/var/log/gitlab
+      - data-ce:/var/opt/gitlab
+      - ./scripts/healthcheck-and-setup.sh:/healthcheck-and-setup.sh
+    healthcheck:
+      test: /healthcheck-and-setup.sh
+      interval: 10s
+      timeout: 2m
+
+  gitlab-ee:
+    image: gitlab/gitlab-ee
+    restart: always
+    ports:
+      - 8080:80
+    environment:
+      GITLAB_ROOT_PASSWORD: adminadmin
+      GITLAB_LICENSE_FILE: /Gitlab-license.txt
+    labels:
+      terraform-provider-gitlab/owned: ''
+    volumes:
+      - config-ee:/etc/gitlab
+      - logs-ee:/var/log/gitlab
+      - data-ee:/var/opt/gitlab
+      - ./scripts/healthcheck-and-setup.sh:/healthcheck-and-setup.sh
+      - ./Gitlab-license.txt:/Gitlab-license.txt
+    healthcheck:
+      test: /healthcheck-and-setup.sh
+      interval: 10s
+      timeout: 2m
+
+volumes:
+  config-ce:
+  logs-ce:
+  data-ce:
+  config-ee:
+  logs-ee:
+  data-ee:
diff --git a/scripts/await-healthy.sh b/scripts/await-healthy.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+
+echo 'Waiting for GitLab container to become healthy'
+
+until test -n "$(docker ps --quiet --filter label=terraform-provider-gitlab/owned --filter health=healthy)"; do
+  printf '.'
+  sleep 5
+done
+
+echo 'GitLab is healthy'
diff --git a/scripts/healthcheck-and-setup.sh b/scripts/healthcheck-and-setup.sh
@@ -0,0 +1,61 @@
+#!/usr/bin/env sh
+
+# This script is intended to be used as a Docker HEALTHCHECK for the GitLab container.
+# It prepares GitLab prior to running acceptance tests.
+#
+# This is a known workaround for docker-compose lacking lifecycle hooks.
+# See: https://github.com/docker/compose/issues/1809#issuecomment-657815188
+
+set -e
+
+# Check for a successful HTTP status code from GitLab.
+curl --silent --show-error --fail --output /dev/null 127.0.0.1:80
+
+# Because this script runs on a regular health check interval,
+# this file functions as a marker that tells us if initialization already finished.
+done=/var/gitlab-acctest-initialized
+
+test -f $done || {
+  echo 'Initializing GitLab for acceptance tests'
+
+  echo 'Creating access token'
+  (
+    printf 'terraform_token = PersonalAccessToken.create('
+    printf 'user_id: 1, '
+    printf 'scopes: [:api, :read_user], '
+    printf 'name: :terraform);'
+    printf "terraform_token.set_token('ACCTEST');"
+    printf 'terraform_token.save!;'
+  ) | gitlab-rails console
+
+  # 2020-09-07: Currently Gitlab (version 13.3.6 ) doesn't allow in admin API
+  # ability to set a group as instance level templates.
+  # To test resource_gitlab_project_test template features we add
+  # group, project myrails and admin settings directly in scripts/start-gitlab.sh
+  # Once Gitlab add admin template in API we could manage group/project/settings
+  # directly in tests like TestAccGitlabProject_basic.
+  # Works on CE too
+
+  echo 'Creating an instance level template group with a simple template based on rails'
+  (
+    printf 'group_template = Group.new('
+    printf 'name: :terraform, '
+    printf 'path: :terraform);'
+    printf 'group_template.save!;'
+    printf 'application_settings = ApplicationSetting.find_by "";'
+    printf 'application_settings.custom_project_templates_group_id = group_template.id;'
+    printf 'application_settings.save!;'
+    printf 'attrs = {'
+    printf 'name: :myrails, '
+    printf 'path: :myrails, '
+    printf 'namespace_id: group_template.id, '
+    printf 'template_name: :rails, '
+    printf 'id: 999};'
+    printf 'project = ::Projects::CreateService.new(User.find_by_username("root"), attrs).execute;'
+    printf 'project.saved?;'
+  ) | gitlab-rails console
+
+  touch $done
+}
+
+echo 'GitLab is ready for acceptance tests'
diff --git a/scripts/start-gitlab.sh b/scripts/start-gitlab.sh

Original file line number	Diff line number	Diff line change
`@@ -32,3 +32,4 @@ website/vendor`
`32`	`32`	`!command/test-fixtures/**/.terraform/`
`33`	`33`
`34`	`34`	`license/*`
	`35`	`+Gitlab-license.txt`