Fix missing fields in show command (#315)

* show empty strings on selected fields

* add maybe.Optional[T] && maybe.Bool

* add Stringer to maybe.Bool

* update all references to *bool with maybe.Bool

* add test for BoolDecoder function

* add test on JSON marshaller/unmarshaller

* set maybe.Bool type to bool in jsonschema

* add a unit test for generating maybe.Bool json schema

* try running ajv tests on github action

* make schema test running under windows

* use nodejs 18

Author: creativeprojects

.github/workflows/build.yml

@@ -36,6 +36,11 @@ jobs:
           check-latest: true
           cache: true
 
+      - name: Set up Node.js LTS for running JSON schema tests (using ajv)
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
       - name: Build
         run: make build
         env:

battery_test.go

@@ -10,11 +10,9 @@ import (
 
 var errTest = errors.New("test error")
 
-func TestNotRunningOnBattery(t *testing.T) {
-	battery, charge, err := IsRunningOnBattery()
+func TestNoErrorIsRunningOnBattery(t *testing.T) {
+	_, _, err := IsRunningOnBattery()
 	assert.NoError(t, err)
-	assert.False(t, battery)
-	assert.Zero(t, charge)
 }
 
 func TestIsFatalError(t *testing.T) {

config/config.go

@@ -15,6 +15,7 @@ import (
 	"github.com/creativeprojects/clog"
 	"github.com/creativeprojects/resticprofile/constants"
 	"github.com/creativeprojects/resticprofile/filesearch"
+	"github.com/creativeprojects/resticprofile/util/maybe"
 	"github.com/creativeprojects/resticprofile/util/templates"
 	"github.com/mitchellh/mapstructure"
 	"github.com/spf13/viper"
@@ -42,6 +43,7 @@ type Config struct {
 var (
 	configOption = viper.DecodeHook(mapstructure.ComposeDecodeHookFunc(
 		mapstructure.StringToTimeDurationHookFunc(),
+		maybe.BoolDecoder(),
 		confidentialValueDecoder(),
 	))
 

config/config_test.go

@@ -10,6 +10,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/creativeprojects/resticprofile/util/maybe"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -198,14 +199,9 @@ profile:
 }
 
 func TestBoolPointer(t *testing.T) {
-	boolPointer := func(value bool) *bool {
-		output := &value
-		return output
-	}
-
 	fixtures := []struct {
 		testTemplate
-		continueOnError *bool
+		continueOnError maybe.Bool
 	}{
 		{
 			testTemplate: testTemplate{
@@ -217,7 +213,7 @@ version = 2
 profiles = []
 `,
 			},
-			continueOnError: nil,
+			continueOnError: maybe.Bool{},
 		},
 		{
 			testTemplate: testTemplate{
@@ -229,7 +225,7 @@ groups:
     profiles: []
 `,
 			},
-			continueOnError: nil,
+			continueOnError: maybe.Bool{},
 		},
 		{
 			testTemplate: testTemplate{
@@ -245,7 +241,7 @@ groups:
 }
 `,
 			},
-			continueOnError: nil,
+			continueOnError: maybe.Bool{},
 		},
 		{
 			testTemplate: testTemplate{
@@ -258,7 +254,7 @@ profiles = []
 continue-on-error = true
 `,
 			},
-			continueOnError: boolPointer(true),
+			continueOnError: maybe.True(),
 		},
 		{
 			testTemplate: testTemplate{
@@ -271,7 +267,7 @@ groups:
   continue-on-error: true
 `,
 			},
-			continueOnError: boolPointer(true),
+			continueOnError: maybe.True(),
 		},
 		{
 			testTemplate: testTemplate{
@@ -288,7 +284,7 @@ groups:
 }
 `,
 			},
-			continueOnError: boolPointer(true),
+			continueOnError: maybe.True(),
 		},
 		{
 			testTemplate: testTemplate{
@@ -301,7 +297,7 @@ profiles = []
 continue-on-error = false
 `,
 			},
-			continueOnError: boolPointer(false),
+			continueOnError: maybe.False(),
 		},
 		{
 			testTemplate: testTemplate{
@@ -314,7 +310,7 @@ groups:
     continue-on-error: false
 `,
 			},
-			continueOnError: boolPointer(false),
+			continueOnError: maybe.False(),
 		},
 		{
 			testTemplate: testTemplate{
@@ -331,7 +327,7 @@ groups:
 }
 `,
 			},
-			continueOnError: boolPointer(false),
+			continueOnError: maybe.False(),
 		},
 	}
 

config/config_v1.go

@@ -6,6 +6,7 @@ import (
 	"reflect"
 
 	"github.com/creativeprojects/resticprofile/constants"
+	"github.com/creativeprojects/resticprofile/util/maybe"
 	"github.com/mitchellh/mapstructure"
 	"github.com/spf13/viper"
 )
@@ -28,11 +29,13 @@ import (
 var (
 	configOptionV1 = viper.DecodeHook(mapstructure.ComposeDecodeHookFunc(
 		mapstructure.StringToTimeDurationHookFunc(),
+		maybe.BoolDecoder(),
 		confidentialValueDecoder(),
 	))
 
 	configOptionV1HCL = viper.DecodeHook(mapstructure.ComposeDecodeHookFunc(
 		mapstructure.StringToTimeDurationHookFunc(),
+		maybe.BoolDecoder(),
 		confidentialValueDecoder(),
 		sliceOfMapsToMapHookFunc(),
 	))
@@ -70,7 +73,7 @@ func (c *Config) loadGroupsV1() (err error) {
 					c.groups[groupName] = Group{
 						Description:     "",
 						Profiles:        group,
-						ContinueOnError: nil,
+						ContinueOnError: maybe.Bool{},
 					}
 				}
 			}

config/display.go

@@ -5,12 +5,18 @@ import (
 	"io"
 	"strings"
 	"text/tabwriter"
+
+	"github.com/fatih/color"
 )
 
 const (
 	indent = "    " // 4 spaces
 )
 
+var (
+	ansiBold = color.New(color.Bold).SprintFunc()
+)
+
 // Display is a temporary struct to display a config object to the console
 type Display struct {
 	topLevel string
@@ -30,6 +36,7 @@ func (d *Display) addEntry(stack []string, key string, values []string) {
 	entry := Entry{
 		section: strings.Join(stack, "."), // in theory we should only have zero or one level, but don't fail if we get more
 		key:     key,
+		keyOnly: false,
 		values:  values,
 	}
 	d.entries = append(d.entries, entry)
@@ -41,9 +48,10 @@ func (d *Display) addKeyOnlyEntry(stack []string, key string) {
 }
 
 func (d *Display) Flush() {
-	tabWriter := tabwriter.NewWriter(d.writer, 0, 2, 2, ' ', 0)
+	const minWidth, tabWidth, padding = 0, 2, 2
+	tabWriter := tabwriter.NewWriter(d.writer, minWidth, tabWidth, padding, ' ', 0)
 	// title
-	fmt.Fprintf(tabWriter, "%s:\n", d.topLevel)
+	fmt.Fprintf(tabWriter, "%s:\n", ansiBold(d.topLevel))
 	section := ""
 	prefix := indent
 	for _, entry := range d.entries {

config/flag.go

@@ -14,12 +14,8 @@ import (
 )
 
 var (
-	emptyStringArray []string
-)
-
-func init() {
 	emptyStringArray = make([]string, 0)
-}
+)
 
 var allowedEmptyValueArgs = []string{
 	constants.ParameterKeepTag, // allows --keep-tag="" - means keep all with any assigned tag
@@ -68,8 +64,8 @@ func addArgsFromStruct(args *shell.Args, section any) {
 	}
 }
 
-func argAliasesFromStruct(section any) (aliases map[string]string) {
-	aliases = make(map[string]string)
+func argAliasesFromStruct(section any) map[string]string {
+	aliases := make(map[string]string)
 	if t := util.ElementType(reflect.TypeOf(section)); t.Kind() == reflect.Struct {
 		for i := 0; i < t.NumField(); i++ {
 			field := t.Field(i)

config/group.go

@@ -1,8 +1,10 @@
 package config
 
+import "github.com/creativeprojects/resticprofile/util/maybe"
+
 // Group of profiles
 type Group struct {
-	Description     string   `mapstructure:"description" description:"Describe the group"`
-	Profiles        []string `mapstructure:"profiles" description:"Names of the profiles belonging to this group"`
-	ContinueOnError *bool    `mapstructure:"continue-on-error" default:"auto" description:"Continue with the next profile on a failure, overrides \"global.group-continue-on-error\""`
+	Description     string     `mapstructure:"description" description:"Describe the group"`
+	Profiles        []string   `mapstructure:"profiles" description:"Names of the profiles belonging to this group"`
+	ContinueOnError maybe.Bool `mapstructure:"continue-on-error" default:"auto" description:"Continue with the next profile on a failure, overrides \"global.group-continue-on-error\""`
 }

config/info_customizer.go

@@ -9,6 +9,7 @@ import (
 	"github.com/creativeprojects/resticprofile/constants"
 	"github.com/creativeprojects/resticprofile/restic"
 	"github.com/creativeprojects/resticprofile/util"
+	"github.com/creativeprojects/resticprofile/util/maybe"
 )
 
 // resticDescriptionReplacements removes or replaces misleading documentation fragments from restic man pages
@@ -123,6 +124,17 @@ func init() {
 		}
 	})
 
+	// Profile: special handling for maybe.Bool
+	maybeBoolType := reflect.TypeOf(maybe.Bool{})
+	registerPropertyInfoCustomizer(func(sectionName, propertyName string, property accessibleProperty) {
+		if field := property.field(); field != nil {
+			if util.ElementType(field.Type).AssignableTo(maybeBoolType) {
+				basic := property.basic().resetTypeInfo()
+				basic.mayBool = true
+			}
+		}
+	})
+
 	// Profile: deprecated sections (squash with deprecated, e.g. schedule in retention)
 	registerPropertyInfoCustomizer(func(sectionName, propertyName string, property accessibleProperty) {
 		if field := property.sectionField(nil); field != nil {

config/info_customizer_test.go

@@ -2,14 +2,16 @@ package config
 
 import (
 	"fmt"
-	"github.com/stretchr/testify/require"
 	"reflect"
 	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
 	"github.com/creativeprojects/resticprofile/constants"
 	"github.com/creativeprojects/resticprofile/restic"
 	"github.com/creativeprojects/resticprofile/util/collect"
+	"github.com/creativeprojects/resticprofile/util/maybe"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -171,6 +173,36 @@ func TestConfidentialProperty(t *testing.T) {
 	}
 }
 
+func TestMaybeBoolProperty(t *testing.T) {
+	var testType = struct {
+		Simple maybe.Bool `mapstructure:"simple"`
+	}{}
+
+	set := propertySetFromType(reflect.TypeOf(testType))
+
+	assert.ElementsMatch(t, []string{"simple"}, set.Properties())
+	for _, name := range set.Properties() {
+		t.Run(name+"/before", func(t *testing.T) {
+			info := set.PropertyInfo(name)
+			require.True(t, info.CanBePropertySet())
+			assert.Equal(t, "Bool", info.PropertySet().TypeName())
+			assert.False(t, info.CanBeBool())
+			assert.False(t, info.IsMultiType())
+		})
+	}
+
+	customizeProperties("any", set.properties)
+
+	for _, name := range set.Properties() {
+		t.Run(name, func(t *testing.T) {
+			info := set.PropertyInfo(name)
+			assert.True(t, info.CanBeBool())
+			assert.False(t, info.CanBePropertySet())
+			assert.False(t, info.IsMultiType())
+		})
+	}
+}
+
 func TestDeprecatedSection(t *testing.T) {
 	var testType = struct {
 		ScheduleBaseSection `mapstructure:",squash" deprecated:"true"`