fix: GitHub tests emitting unexpected keepers = {} (#4462)

.github/workflows/test.yml

@@ -33,6 +33,7 @@ jobs:
           filters: |
             go:
               - '**.go'
+              - '**.txt' # golden file test output
               - 'go.*'
               - '.github/workflows/test.yml'
   test:
@@ -51,6 +52,7 @@ jobs:
 
       - run: make test-all
       - run: make check-fmt
+
       ###########################################################
       # Notifying #contributors about test failure on main branch
       ###########################################################

Makefile

@@ -98,7 +98,7 @@ check-lint: ## Run linter in CI/CD. If running locally use 'lint'
 
 .PHONY: check-fmt
 check-fmt: ## Fail if not formatted
-	if [[ $$(goimports -l $$(find . -type f -name '*.go' ! -path "./vendor/*" ! -path "**/mocks/*")) ]]; then exit 1; fi
+	./scripts/fmt.sh
 
 .PHONY: end-to-end-deps
 end-to-end-deps: ## Install e2e dependencies

scripts/fmt.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+go install golang.org/x/tools/cmd/goimports@latest
+
+gobin="$(go env GOPATH)/bin"
+declare -r gobin
+
+declare -a files
+readarray -d '' files < <(find . -type f -name '*.go' ! -name 'mock_*' ! -path './vendor/*' ! -path '**/mocks/*' -print0)
+declare -r files
+
+output="$("${gobin}"/goimports -l "${files[@]}")"
+declare -r output
+
+if [[ -n "$output" ]]; then
+    echo "These files had their 'import' changed - please fix them locally and push a fix"
+
+    echo "$output"
+
+    exit 1
+fi

server/controllers/events/testdata/test-repos/import-multiple-project/dir1/main.tf

@@ -1,4 +1,3 @@
 resource "random_id" "dummy1" {
-  keepers     = {}
   byte_length = 1
 }

server/controllers/events/testdata/test-repos/import-multiple-project/dir2/main.tf

@@ -1,4 +1,3 @@
 resource "random_id" "dummy2" {
-  keepers     = {}
   byte_length = 1
 }

server/controllers/events/testdata/test-repos/import-multiple-project/exp-output-autoplan.txt

@@ -22,7 +22,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -59,7 +58,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -89,4 +87,4 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/import-multiple-project/exp-output-plan-again.txt

@@ -43,7 +43,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -73,4 +72,4 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/import-single-project-var/exp-output-autoplan.txt

@@ -17,7 +17,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
   # random_id.for_each["default"] will be created
@@ -28,7 +27,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 2 to add, 0 to change, 0 to destroy.
@@ -54,4 +52,4 @@ Plan: 2 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/import-single-project-var/main.tf

@@ -1,12 +1,10 @@
 resource "random_id" "for_each" {
   for_each    = toset([var.var])
-  keepers     = {}
   byte_length = 1
 }
 
 resource "random_id" "count" {
   count       = 1
-  keepers     = {}
   byte_length = 1
 }
 

server/controllers/events/testdata/test-repos/import-single-project/exp-output-autoplan.txt

@@ -17,7 +17,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
   # random_id.dummy2 will be created
@@ -28,7 +27,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 2 to add, 0 to change, 0 to destroy.
@@ -54,4 +52,4 @@ Plan: 2 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/import-single-project/main.tf

@@ -1,9 +1,7 @@
 resource "random_id" "dummy1" {
-  keepers     = {}
   byte_length = 1
 }
 
 resource "random_id" "dummy2" {
-  keepers     = {}
   byte_length = 1
 }

server/controllers/events/testdata/test-repos/import-workspace/dir1/main.tf

@@ -1,14 +1,12 @@
 resource "random_id" "dummy1" {
   count = terraform.workspace == "ops" ? 1 : 0
 
-  keepers     = {}
   byte_length = 1
 }
 
 resource "random_id" "dummy2" {
   count = terraform.workspace == "ops" ? 1 : 0
 
-  keepers     = {}
   byte_length = 1
 }
 

server/controllers/events/testdata/test-repos/state-rm-multiple-project/dir1/main.tf

@@ -1,4 +1,3 @@
 resource "random_id" "dummy" {
-  keepers     = {}
   byte_length = 1
 }

server/controllers/events/testdata/test-repos/state-rm-multiple-project/dir2/main.tf

@@ -1,4 +1,3 @@
 resource "random_id" "dummy" {
-  keepers     = {}
   byte_length = 1
 }

server/controllers/events/testdata/test-repos/state-rm-multiple-project/exp-output-autoplan.txt

@@ -22,7 +22,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -59,7 +58,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -89,4 +87,4 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/state-rm-multiple-project/exp-output-plan-again.txt

@@ -22,7 +22,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -59,7 +58,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -89,4 +87,4 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/state-rm-single-project/exp-output-autoplan.txt

@@ -17,7 +17,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
   # random_id.for_each["default"] will be created
@@ -28,7 +27,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
   # random_id.simple will be created
@@ -39,7 +37,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 3 to add, 0 to change, 0 to destroy.
@@ -65,4 +62,4 @@ Plan: 3 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/state-rm-single-project/exp-output-plan-again.txt

@@ -17,7 +17,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
   # random_id.for_each["overridden"] will be created
@@ -28,7 +27,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
   # random_id.simple will be created
@@ -39,7 +37,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 3 to add, 0 to change, 0 to destroy.
@@ -65,4 +62,4 @@ Plan: 3 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```

server/controllers/events/testdata/test-repos/state-rm-single-project/main.tf

@@ -1,17 +1,14 @@
 resource "random_id" "simple" {
-  keepers     = {}
   byte_length = 1
 }
 
 resource "random_id" "for_each" {
   for_each    = toset([var.var])
-  keepers     = {}
   byte_length = 1
 }
 
 resource "random_id" "count" {
   count       = 1
-  keepers     = {}
   byte_length = 1
 }
 

server/controllers/events/testdata/test-repos/state-rm-workspace/dir1/main.tf

@@ -1,7 +1,6 @@
 resource "random_id" "dummy1" {
   count = terraform.workspace == "ops" ? 1 : 0
 
-  keepers     = {}
   byte_length = 1
 }
 

server/controllers/events/testdata/test-repos/state-rm-workspace/exp-output-plan-again.txt

@@ -17,7 +17,6 @@ Terraform will perform the following actions:
       + dec         = (known after apply)
       + hex         = (known after apply)
       + id          = (known after apply)
-      + keepers     = {}
     }
 
 Plan: 1 to add, 0 to change, 0 to destroy.
@@ -43,4 +42,4 @@ Plan: 1 to add, 0 to change, 0 to destroy.
 * :put_litter_in_its_place: To **delete** all plans and locks from this Pull Request, comment:
   ```shell
   atlantis unlock
-  ```
+  ```