Add scripts and pipeline workflows (#10)

* Add script files
* Add a workflow job for linting

Author: jwillp

.github/workflows/go.yml

@@ -1,3 +1,17 @@
+# Copyright 2024 Morébec
+#
+# 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
+#
+#      http://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.
+
 # This workflow will build a golang project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
 
@@ -10,6 +24,31 @@ on:
     branches: [ "main" ]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      - name: Add License
+        run: ./scripts/add_license.sh
+
+      - name: Check Format
+        run: ./scripts/check_gofmt.sh
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+              echo "::set-output name=invalidCommit::true"
+          fi
+
+      - name: Lint
+        run: ./scripts/golangci_lint.sh
 
   build:
     runs-on: ubuntu-latest

.gitignore

@@ -18,4 +18,9 @@
 .vscode/
 .idea/
 
-.specter.json
+# Specter
+.specter.json
+
+# Utilities
+.husky
+

Taskfile.yml

@@ -0,0 +1,27 @@
+# Copyright 2024 Morébec
+#
+# 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
+#
+#      http://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.
+
+version: '3'
+
+tasks:
+  dev:install:
+    cmds:
+      - chmod +x ./scripts/*
+      - ./scripts/husky.sh
+
+  dev:lint:
+    cmds:
+      - ./scripts/add_license.sh
+      - ./scripts/check_gofmt.sh
+      - ./scripts/golangci_lint.sh

artifactregistry.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (
@@ -113,10 +127,7 @@ func (r *JSONArtifactRegistry) Add(processorName string, e ArtifactRegistryEntry
 		r.Entries[processorName] = make([]JsonArtifactRegistryEntry, 0)
 	}
 
-	r.Entries[processorName] = append(r.Entries[processorName], JsonArtifactRegistryEntry{
-		ArtifactID: e.ArtifactID,
-		Metadata:   e.Metadata,
-	})
+	r.Entries[processorName] = append(r.Entries[processorName], JsonArtifactRegistryEntry(e))
 
 	return nil
 }
@@ -151,10 +162,7 @@ func (r *JSONArtifactRegistry) FindByID(processorName string, artifactID Artifac
 
 	for _, entry := range r.Entries[processorName] {
 		if entry.ArtifactID == artifactID {
-			return ArtifactRegistryEntry{
-				ArtifactID: entry.ArtifactID,
-				Metadata:   entry.Metadata,
-			}, true, nil
+			return ArtifactRegistryEntry(entry), true, nil
 		}
 	}
 
@@ -171,10 +179,7 @@ func (r *JSONArtifactRegistry) FindAll(processorName string) ([]ArtifactRegistry
 
 	var entries []ArtifactRegistryEntry
 	for _, entry := range r.Entries[processorName] {
-		entries = append(entries, ArtifactRegistryEntry{
-			ArtifactID: entry.ArtifactID,
-			Metadata:   entry.Metadata,
-		})
+		entries = append(entries, ArtifactRegistryEntry(entry))
 	}
 
 	return entries, nil

artifactregistry_test.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (
@@ -157,6 +171,7 @@ func TestJSONArtifactRegistry_Save(t *testing.T) {
 				require.NoError(t, err)
 			}
 			actualJSON, err := fs.ReadFile(filePath)
+			require.NoError(t, err)
 			assert.JSONEq(t, tt.then.expectedJSON, string(actualJSON))
 		})
 	}

assembly.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (

depresolve_test.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (

fileartifactprocessor.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (
@@ -182,7 +196,7 @@ func (p FileArtifactProcessor) cleanRegistry(ctx ArtifactProcessingContext) erro
 	var wg sync.WaitGroup
 	var errs errors.Group
 
-	ctx.Logger.Info(fmt.Sprintf("Cleaning file artifacts ..."))
+	ctx.Logger.Info("Cleaning file artifacts ...")
 	entries, err := ctx.ArtifactRegistry.FindAll()
 	if err != nil {
 		return err
@@ -230,7 +244,7 @@ func (p FileArtifactProcessor) cleanArtifact(ctx ArtifactProcessingContext, entr
 		return nil
 	}
 
-	ctx.Logger.Info(fmt.Sprintf(fmt.Sprintf("cleaning file artifact %q ...", entry.ArtifactID)))
+	ctx.Logger.Info(fmt.Sprintf("cleaning file artifact %q ...", entry.ArtifactID))
 	if err := p.FileSystem.Remove(path); err != nil {
 		return err
 	}

fileartifactprocessor_test.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (

filesystem.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (

filesystem_test.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (
@@ -16,11 +30,10 @@ var _ FileSystem = (*mockFileSystem)(nil)
 // Mock implementations to use in tests.
 type mockFileInfo struct {
 	os.FileInfo
-	name    string
-	size    int64
-	mode    os.FileMode
-	modTime int64
-	isDir   bool
+	name  string
+	size  int64
+	mode  os.FileMode
+	isDir bool
 }
 
 func (m mockFileInfo) Type() fs.FileMode {

hcl.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (
@@ -116,7 +130,7 @@ func (l HCLGenericSpecLoader) extractAttributesFromBlock(ctx *hcl.EvalContext, b
 	for _, a := range block.Body.Attributes {
 		value, d := a.Expr.Value(ctx)
 		if d != nil && d.HasErrors() {
-			d = append(diags, d...)
+			diags = append(diags, d...)
 			continue
 		}
 

linting.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (
@@ -183,7 +197,7 @@ func SpecificationsMustHaveUniqueNames(severity LinterResultSeverity) Specificat
 					fnMap[fn] = struct{}{}
 				}
 				var fileNames []string
-				for fn, _ := range fnMap {
+				for fn := range fnMap {
 					fileNames = append(fileNames, fn)
 				}
 

linting_test.go

@@ -1,3 +1,17 @@
+// Copyright 2024 Morébec
+//
+// 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
+//
+//      http://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 specter
 
 import (