Improve CI (#12)

* Check license headers * Run shellcheck * Add script for creating tags * Run Mage with -v Signed-off-by: Reinhard Naegele <[email protected]>
craftypath · Mar 17, 2020 · 3e7b295 · 3e7b295
1 parent 2bf8b58
commit 3e7b295
Show file tree

Hide file tree

Showing 19 changed files with 264 additions and 14 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -12,3 +12,6 @@ charset = utf-8
 [*.go]
 indent_style = tab
 indent_size = 4
+
+[*.sh]
+indent_size = 4
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -32,18 +32,21 @@ jobs:
           ./setup.sh
           echo "::add-path::$(go env GOPATH)/bin"
 
+      - name: Check License Headers
+        run: mage -v checkLicenseHeaders
+
       - name: Lint
-        run: mage lint
+        run: mage -v lint
 
       - name: Test
-        run: mage test
+        run: mage -v test
 
       - name: Build
         if: "!startsWith(github.ref, 'refs/tags')"
-        run: mage build
+        run: mage -v build
 
       - name: Release
         if: startsWith(github.ref, 'refs/tags/v')
-        run: mage release
+        run: mage -v release
         env:
           GITHUB_TOKEN: ${{ secrets.CI_TOKEN }}
diff --git a/LICENSE b/LICENSE
@@ -192,7 +192,7 @@
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+       https://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/check_license_headers.sh b/check_license_headers.sh
@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# Copyright The gotf Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+regex_find() {
+    local dir="$1"
+    local pattern="$2"
+
+    if [[ "$OSTYPE" == darwin* ]]; then
+        find -E "$dir" -regex "$pattern"
+    else
+        find "$dir" -regextype posix-extended -regex "$pattern"
+    fi
+}
+
+check_header() {
+    local file="$1"
+
+    grep -q '// Copyright The gotf Authors' "$file"
+    grep -q 'https://www.apache.org/licenses/LICENSE-2.0' "$file"
+}
+
+main() {
+    local files_without_header=()
+
+    for file in $(regex_find . '.*\.(sh|go)'); do
+        if ! check_header "$file"; then
+            files_without_header+=("$file")
+        fi
+    done
+
+    if [[ -n "${files_without_header[*]}" ]]; then
+        echo "ERROR: Files without license header found:" >&2
+        printf '%s\n' "${files_without_header[@]}" >&2
+        exit 1
+    fi
+}
+
+main
diff --git a/cmd/gotf/gotf.go b/cmd/gotf/gotf.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/cmd/gotf/gotf_test.go b/cmd/gotf/gotf_test.go
@@ -1,3 +1,17 @@
+// Copyright The gotf Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package gotf
 
 import (

diff --git a/magefile.go b/magefile.go
@@ -1,12 +1,30 @@
+// Copyright The gotf Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 // +build mage
 
 package main
 
 import (
+	"github.com/magefile/mage/mg"
 	"github.com/magefile/mage/sh"
 )
 
 func Lint() error {
+	if err := sh.RunV("bash", "-c", "shopt -s globstar; shellcheck **/*.sh"); err != nil {
+		return err
+	}
 	if err := sh.RunV("golangci-lint", "run"); err != nil {
 		return err
 	}
@@ -22,6 +40,10 @@ func Lint() error {
 	return sh.RunV("git", "diff", "--exit-code")
 }
 
+func CheckLicenseHeaders() error {
+	return sh.RunV("./check_license_headers.sh")
+}
+
 func Test() error {
 	return sh.RunV("go", "test", "./...", "-race")
 }
@@ -31,5 +53,6 @@ func Build() error {
 }
 
 func Release() error {
+	mg.Deps(Test)
 	return sh.RunV("goreleaser", "release", "--rm-dist")
 }
diff --git a/main.go b/main.go
@@ -1,3 +1,17 @@
+// Copyright The gotf Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package main
 
 import "github.com/craftypath/gotf/cmd/gotf"

diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/gotf/gotf.go b/pkg/gotf/gotf.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/opts/opts.go b/pkg/opts/opts.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/sh/sh.go b/pkg/sh/sh.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/tf/installer.go b/pkg/tf/installer.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/tf/installer_test.go b/pkg/tf/installer_test.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/tf/terraform.go b/pkg/tf/terraform.go
@@ -4,7 +4,7 @@
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
-//     http://www.apache.org/licenses/LICENSE-2.0
+//     https://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/pkg/tools/tools.go b/pkg/tools/tools.go
@@ -1,3 +1,17 @@
+// Copyright The gotf Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 // +build tools
 
 package tools

diff --git a/setup.sh b/setup.sh
@@ -1,5 +1,19 @@
 #!/usr/bin/env bash
 
+# Copyright The gotf Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 go install github.com/golangci/golangci-lint/cmd/golangci-lint
 go install github.com/goreleaser/goreleaser
 go install github.com/magefile/mage