Continue profile in group on error (#149)

* continue profile in group on error

* split doc compilation and doc release

* compile doc on PR

* upgrade codecov action

* checkout first

* remove cache in doc

* flag renamed continue-on-error

* set continue-on-error to false can override global

* add a test to make sure it works on all formats

Author: creativeprojects

.github/workflows/build.yml

@@ -23,13 +23,15 @@ jobs:
 
     steps:
 
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
       - name: Set up Go ${{ matrix.go_version }}
         uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go_version }}
-
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v3
+          check-latest: true
+          cache: true
 
       - name: Generate mocks
         run: make mocks
@@ -44,7 +46,7 @@ jobs:
         shell: bash
 
       - name: Code coverage with codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
 
       - name: Archive code coverage results
         uses: actions/upload-artifact@v3

.github/workflows/doc.yml

@@ -3,25 +3,30 @@ name: documentation
 on:
   push:
     branches:
-      - master  # Set a branch to deploy
+      - master
     paths:
       - "docs/**"
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'docs/**'
 
 jobs:
-  deploy:
+  build:
     runs-on: ubuntu-latest
     steps:
 
-      - name: Set up Go 1.19
-        uses: actions/setup-go@v3
-        with:
-          go-version: 1.19
-
       - uses: actions/checkout@v3
         with:
           submodules: true  # Fetch Hugo themes (true OR recursive)
           fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
 
+      - name: Set up Go 1.19
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
       - name: Check configuration snippets in documentation
         run: go run ./config/checkdoc -r docs/content
         shell: bash
@@ -34,11 +39,3 @@ jobs:
 
       - name: Build
         run: cd docs && hugo --minify
-
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        # if: github.ref == 'refs/heads/main'
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_branch: gh-docs
-          publish_dir: ./public

.github/workflows/release-doc.yml

@@ -0,0 +1,42 @@
+name: documentation
+
+on:
+  push:
+    tags:
+      - '*'
+  
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Set up Go 1.19
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      - uses: actions/checkout@v3
+        with:
+          submodules: true  # Fetch Hugo themes (true OR recursive)
+          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
+
+      - name: Check configuration snippets in documentation
+        run: go run ./config/checkdoc -r docs/content
+        shell: bash
+        
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v2
+        with:
+          hugo-version: 'latest'
+          extended: true
+
+      - name: Build
+        run: cd docs && hugo --minify
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        # if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-docs
+          publish_dir: ./public

bools/bools.go

@@ -0,0 +1,33 @@
+package bools
+
+func IsTrue(value *bool) bool {
+	if value == nil {
+		return false
+	}
+	return *value
+}
+
+func IsStrictlyFalse(value *bool) bool {
+	if value == nil {
+		return false
+	}
+	return !*value
+}
+
+func IsFalseOrUndefined(value *bool) bool {
+	if value == nil {
+		return true
+	}
+	return !*value
+}
+
+func IsUndefined(value *bool) bool {
+	return value == nil
+}
+
+func IsTrueOrUndefined(value *bool) bool {
+	if value == nil {
+		return true
+	}
+	return *value
+}

bools/bools_test.go

@@ -0,0 +1,66 @@
+package bools
+
+import (
+	"strconv"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestBools(t *testing.T) {
+	fixtures := []struct {
+		source             *bool
+		isTrue             bool
+		isStrictlyFalse    bool
+		isFalseOrUndefined bool
+		isUndefined        bool
+		isTrueOrUndefined  bool
+	}{
+		{
+			source:             nil,
+			isTrue:             false,
+			isStrictlyFalse:    false,
+			isFalseOrUndefined: true,
+			isUndefined:        true,
+			isTrueOrUndefined:  true,
+		},
+		{
+			source:             boolPointer(true),
+			isTrue:             true,
+			isStrictlyFalse:    false,
+			isFalseOrUndefined: false,
+			isUndefined:        false,
+			isTrueOrUndefined:  true,
+		},
+		{
+			source:             boolPointer(false),
+			isTrue:             false,
+			isStrictlyFalse:    true,
+			isFalseOrUndefined: true,
+			isUndefined:        false,
+			isTrueOrUndefined:  false,
+		},
+	}
+
+	for _, fixture := range fixtures {
+		t.Run(toString(fixture.source), func(t *testing.T) {
+			assert.Equal(t, fixture.isTrue, IsTrue(fixture.source))
+			assert.Equal(t, fixture.isStrictlyFalse, IsStrictlyFalse(fixture.source))
+			assert.Equal(t, fixture.isFalseOrUndefined, IsFalseOrUndefined(fixture.source))
+			assert.Equal(t, fixture.isUndefined, IsUndefined(fixture.source))
+			assert.Equal(t, fixture.isTrueOrUndefined, IsTrueOrUndefined(fixture.source))
+		})
+	}
+}
+
+func boolPointer(value bool) *bool {
+	output := &value
+	return output
+}
+
+func toString(value *bool) string {
+	if value == nil {
+		return "<nil>"
+	}
+	return strconv.FormatBool(*value)
+}

config/config_test.go

@@ -197,6 +197,157 @@ profile:
 	}
 }
 
+func TestBoolPointer(t *testing.T) {
+	boolPointer := func(value bool) *bool {
+		output := &value
+		return output
+	}
+
+	fixtures := []struct {
+		testTemplate
+		continueOnError *bool
+	}{
+		{
+			testTemplate: testTemplate{
+				format: FormatTOML,
+				config: `
+version = 2
+[groups]
+[groups.groupname]
+profiles = []
+`,
+			},
+			continueOnError: nil,
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatYAML,
+				config: `
+version: 2
+groups:
+  groupname:
+    profiles: []
+`,
+			},
+			continueOnError: nil,
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatJSON,
+				config: `
+{
+	"version": 2,
+	"groups": {
+		"groupname":{
+			"profiles": []
+		}
+	}
+}
+`,
+			},
+			continueOnError: nil,
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatTOML,
+				config: `
+version = 2
+[groups]
+[groups.groupname]
+profiles = []
+continue-on-error = true
+`,
+			},
+			continueOnError: boolPointer(true),
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatYAML,
+				config: `
+version: 2
+groups:
+ groupname:
+  profiles: []
+  continue-on-error: true
+`,
+			},
+			continueOnError: boolPointer(true),
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatJSON,
+				config: `
+{
+	"version": 2,
+	"groups": {
+		"groupname":{
+			"profiles": [],
+			"continue-on-error": true
+		}
+	}
+}
+`,
+			},
+			continueOnError: boolPointer(true),
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatTOML,
+				config: `
+version = 2
+[groups]
+[groups.groupname]
+profiles = []
+continue-on-error = false
+`,
+			},
+			continueOnError: boolPointer(false),
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatYAML,
+				config: `
+version: 2
+groups:
+  groupname:
+    profiles: []
+    continue-on-error: false
+`,
+			},
+			continueOnError: boolPointer(false),
+		},
+		{
+			testTemplate: testTemplate{
+				format: FormatJSON,
+				config: `
+{
+	"version": 2,
+	"groups": {
+		"groupname":{
+			"profiles": [],
+			"continue-on-error": false
+		}
+	}
+}
+`,
+			},
+			continueOnError: boolPointer(false),
+		},
+	}
+
+	for _, fixture := range fixtures {
+		t.Run(fixture.format, func(t *testing.T) {
+			c, err := Load(bytes.NewBufferString(fixture.config), fixture.format)
+			require.NoError(t, err)
+
+			group, err := c.GetProfileGroup("groupname")
+			require.NoError(t, err)
+
+			assert.Equal(t, fixture.continueOnError, group.ContinueOnError)
+		})
+	}
+}
+
 func TestGetIncludes(t *testing.T) {
 	config, err := Load(bytes.NewBufferString(`includes=["i1", "i2"]`), "toml")
 	require.NoError(t, err)