feat: migrate CLI to use cobra

.github/workflows/go.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.22'
+        go-version: '1.21'
 
     - name: Download dependencies
       run: go mod download
@@ -34,7 +34,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.22'
+        go-version: '1.21'
 
     - name: Static Analysis
       run: go vet ./...
@@ -51,7 +51,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.22'
+        go-version: '1.21'
 
     - name: Build
       run: |
@@ -72,7 +72,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.22'
+        go-version: '1.21'
 
     - name: Unit test
       run: go test -v -cover -coverprofile coverage.out ./...

.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         goos: ${{ matrix.goos }}
         goarch: ${{ matrix.goarch }}
-        go_version: 1.22
+        go_version: 1.21
         binary_name: "validator"
         ldflags: -w -s -extldflags "-static" -X github.com/Boeing/config-file-validator.version=${{ github.event.release.tag_name }}
         build_tags: -tags netgo
@@ -46,7 +46,7 @@ jobs:
     strategy:
       matrix:
         include:
-          - base: "alpine:3.19"
+          - base: "alpine:3.18"
             postfix: ""
           - base: "scratch"
             postfix: "-scratch"

CONTRIBUTING.md

@@ -6,16 +6,16 @@ We welcome contributions! We want to make contributing to this project as easy a
 - Submitting a fix
 - Proposing new features
 
-## We Develop with GitHub
-We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+## We Develop with Github
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
 
-## We Use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
-Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
+## We Use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
 
-1. Fork the repository and create your branch from `main`.
+1. Fork the repo and create your branch from `main`.
 2. If you've added code that should be tested, add tests.
 3. Ensure the test suite passes.
 4. Submit that pull request!
 
-## Report bugs using GitHub's [issues](https://github.com/boeing/config-file-validator/issues)
+## Report bugs using Github's [issues](https://github.com/boeing/config-file-validator/issues)
 We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/Boeing/config-file-validator/issues/new);

Dockerfile

@@ -1,6 +1,6 @@
-ARG BASE_IMAGE=alpine:3.19
+ARG BASE_IMAGE=alpine:3.18
 
-FROM golang:1.22 as go-builder
+FROM golang:1.21 as go-builder
 ARG VALIDATOR_VERSION=unknown
 COPY . /build/
 WORKDIR /build

PKGBUILD

@@ -1,7 +1,7 @@
 # Maintainer: Clayton Kehoe <118750525+kehoecj@users.noreply.github.com>
 # Author : wiz64 <wiz64.com>
 pkgname=config-file-validator
-pkgver=1.6.0
+pkgver=1.5.0
 pkgrel=1
 pkgdesc="A tool to validate the syntax of configuration files"
 arch=('x86_64')

README.md

@@ -5,16 +5,12 @@
 </div>
 
 <p align="center">
-<img id="cov" src="https://img.shields.io/badge/Coverage-95.2%25-brightgreen" alt="Code Coverage">
+<img id="cov" src="https://img.shields.io/badge/Coverage-95.3%25-brightgreen" alt="Code Coverage">
 
   <a href="https://opensource.org/licenses/Apache-2.0">
   <img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Apache 2 License">
   </a>
 
-  <a href="https://github.com/avelino/awesome-go">
-  <img src="https://awesome.re/mentioned-badge.svg" alt="Awesome Go">
-  </a>  
-
   <a href="https://pkg.go.dev/github.com/Boeing/config-file-validator">
   <img src="https://pkg.go.dev/badge/github.com/Boeing/config-file-validator.svg" alt="Go Reference">
   </a>
@@ -31,9 +27,7 @@
 ## Supported config files formats:
 * Apple PList XML
 * CSV
-* ENV
 * HCL
-* HOCON
 * INI
 * JSON
 * Properties
@@ -50,24 +44,24 @@ There are several ways to install the config file validator tool
 
 ### Docker
 
-We offer Alpine, Ubuntu, and Scratch containers
+We offer alpine, ubuntu, and scratch containers
 
 #### Alpine
 
 ```
-docker pull ghcr.io/boeing/config-file-validator:v1.6.0
+docker pull ghcr.io/boeing/config-file-validator:v1.5.0
 ```
 
 #### Ubuntu
 
 ```
-docker pull ghcr.io/boeing/config-file-validator-ubuntu:v1.6.0
+docker pull ghcr.io/boeing/config-file-validator-ubuntu:v1.5.0
 ```
 
 #### Scratch
 
 ```
-docker pull ghcr.io/boeing/config-file-validator-scratch:v1.6.0
+docker pull ghcr.io/boeing/config-file-validator-scratch:v1.5.0
 ```
 
 ### Binary Releases
@@ -92,15 +86,15 @@ makepkg -si
 If you have a go environment on your desktop you can use [go install](https://go.dev/doc/go-get-install-deprecation) to install the validator executable. The validator executable will be installed to the directory named by the GOBIN environment variable, which defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH environment variable is not set.
 
 ```
-go install github.com/Boeing/config-file-validator/cmd/validator@v1.6.0
+go install github.com/Boeing/config-file-validator/cmd/validator@v1.5.0
 ```
 
 ## Usage
 ```
 Usage: validator [OPTIONS] [<search_path>...]
 
 positional arguments:
-    search_path: The search path on the filesystem for configuration files. Defaults to the current working directory if no search_path provided
+    search_path: The search path on the filesystem for configuration files. Defaults to the current working directory if no search_path provided. Multiple search paths can be declared separated by a space.
 
 optional flags:
   -depth int
@@ -109,12 +103,10 @@ optional flags:
     	Subdirectories to exclude when searching for configuration files
   -exclude-file-types string
     	A comma separated list of file types to ignore
-  -groupby string
-    	Group output by filetype, directory, pass-fail. Supported for Standard and JSON reports
   -output string
-    	Destination to a file to output results
-  -quiet
-    	If quiet flag is set. It doesn't print any output to stdout.
+        Destination to a file to output results
+  -groupby string
+        Group the output by filetype, pass-fail, or directory. Supported Reporters are Standard and JSON
   -reporter string
     	Format of the printed report. Options are standard and json (default "standard")
   -version
@@ -131,7 +123,7 @@ validator /path/to/search
 ![Standard Run](./img/standard_run.png)
 
 #### Multiple search paths
-Multiple search paths are supported, and the results will be merged into a single report
+Multiple search paths are supported and the results will be merged into a single report
 ```
 validator /path/to/search /another/path/to/search
 ```
@@ -148,7 +140,7 @@ validator --exclude-dirs=/path/to/search/tests /path/to/search
 ![Exclude Dirs Run](./img/exclude_dirs.png)
 
 #### Exclude file types
-Exclude file types in the search path. Available file types are `csv`, `env`, `hcl`, `hocon`, `ini`, `json`, `plist`, `properties`, `toml`, `xml`, `yaml`, and `yml`
+Exclude file types in the search path. Available file types are `csv`, `hcl`, `ini`, `json`, `plist`, `properties`, `toml`, `xml`, `yaml`, and `yml`
 
 ```
 validator --exclude-file-types=json /path/to/search
@@ -166,55 +158,39 @@ validator --depth=0 /path/to/search
 ![Custom Recursion Run](./img/custom_recursion.png)
 
 #### Customize report output
-Customize the report output. Available options are `standard`, `junit`, and `json`
+Customize the report output. Available options are `standard` and `json`
 
 ```
 validator --reporter=json /path/to/search
 ```
 
 ![Exclude File Types Run](./img/custom_reporter.png)
 
-### Group report output
-Group the report output by file type, directory, or pass-fail. Supports one or more groupings.
-
-```
-validator -groupby filetype
-```
-
-![Groupby File Type](./img/gb-filetype.png)
-
-#### Multiple groups
-```
-validator -groupby directory,pass-fail
-```
-
-![Groupby File Type and Pass/Fail](./img/gb-filetype-and-pass-fail.png)
-
-### Output results to a file
-Output report results to a file (default name is `result.{extension}`). Must provide reporter flag with a supported extension format. Available options are `junit` and `json`. If an existing directory is provided, create a file named default name in the given directory. If a file name is provided, create a file named the given name at the current working directory.
-
+#### Output results to a file
+Output report results to a file (default name is `result.{extension}`). Must provide reporter flag with a supported extension format (Available option is `json`). If an existing directory is provided, create a file named default name in the given directory. If a file name is provided, create a file named the given name at the current working directory.
 ```
 validator --reporter=json --output=/path/to/dir
 ```
 
-### Suppress output
-Passing the `--quiet` flag suppresses all output to stdout. If there are invalid config files the validator tool will exit with 1. Any errors in execution such as an invalid path will still be displayed.
+### Group report output
+Group the report output by file type, directory, or pass-fail. Supports one or more groupings.
 
 ```
-validator --quiet /path/to/search
+validator -groupby filetype
+validator -groupby directory,pass-fail
 ```
 
 #### Container Run
 ```
-docker run -it --rm -v /path/to/config/files:/test config-file-validator:1.6.0 /test
+docker run -it --rm -v /path/to/config/files:/test config-file-validator:1.5.0 /test
 ```
 
 ![Docker Standard Run](./img/docker_run.png)
 
 ## Build
-The project can be downloaded and built from source using an environment with Go 1.21+ installed. After a successful build, the binary can be moved to a location on your operating system PATH.
+The project can be downloaded and built from source using an environment with golang 1.21 installed. After a successful build, the binary can be moved to a location on your operating system PATH.
 
-### macOS
+### MacOS
 #### Build
 ```
 CGO_ENABLED=0 \
@@ -276,14 +252,9 @@ cp .\validator.exe 'C:\Program Files\validator'
 You can also use the provided Dockerfile to build the config file validator tool as a container
 
 ```
-docker build . -t config-file-validator:v1.6.0
+docker build . -t config-file-validator:v1.5.0
 ```
 
-## Contributors
-<a href="https://github.com/Boeing/config-file-validator/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=Boeing/config-file-validator" />
-</a>
-
 ## Contributing
 We welcome contributions! Please refer to our [contributing guide](/CONTRIBUTING.md)
 

cmd/validator/commands/flags.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	validator "github.com/Boeing/config-file-validator/cmd/validator"
+	"github.com/spf13/cobra"
+)
+
+func CmdFlags(cmd *cobra.Command) {
+	cmd.PersistentFlags().
+		IntVar(&validator.Flags.Depth, "depth", 0, "Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal.")
+	cmd.PersistentFlags().
+		StringVar(&validator.Flags.ExcludeDirs, "exclude-dirs", "", "Subdirectories to exclude when searching for configuration files")
+	cmd.PersistentFlags().
+		StringVar(&validator.Flags.ExcludeFileTypes, "exclude-file-types", "", "A comma separated list of file types to ignore")
+	cmd.PersistentFlags().StringVar(&validator.Flags.Output, "output", "", "Destination to a file to output results")
+	cmd.PersistentFlags().
+		StringVar(&validator.Flags.ReportType, "reporter", "standard", "Format of the printed report. Options are standard and json")
+	cmd.PersistentFlags().
+		StringVar(&validator.Flags.GroupOutput, "groupby", "", "Group output by filetype, directory, pass-fail. Supported for Standard and JSON reports")
+	cmd.PersistentFlags().
+		StringVar(&validator.Flags.SearchPath, "search_path", ".", "search_path: The search path on the filesystem for configuration files. Defaults to the current working directory if no search_path provided.")
+}
+
+func init() {
+	CmdFlags(rootCmd)
+}

cmd/validator/commands/flags_test.go

@@ -0,0 +1,68 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"strings"
+	"testing"
+
+	cmd "github.com/Boeing/config-file-validator/cmd/validator"
+	"github.com/spf13/cobra"
+)
+
+func ExecuteTestHelper(t *testing.T, c *cobra.Command, args ...string) (string, error) {
+	t.Helper()
+
+	buf := new(bytes.Buffer)
+	c.SetOut(buf)
+	c.SetErr(buf)
+	c.SetArgs(args)
+
+	err := c.Execute()
+	return strings.TrimSpace(buf.String()), err
+}
+
+func Test_flags(t *testing.T) {
+	// We manipulate the Args to set them up for the testcases
+	cases := []struct {
+		Name         string
+		Args         []string
+		ExpectedExit int
+	}{
+		{"blank", []string{}, 0},
+		{"negative depth set", []string{"--depth", "-1", "--reporter", "standard"}, 1},
+		{"flags set, wrong reporter", []string{"--exclude-dirs", "subdir", "--reporter", "wrong"}, 1},
+		{"flags set, json reporter", []string{"--exclude-dirs", "subdir", "--reporter", "json"}, 0},
+		{"flags set, junit reported", []string{"--exclude-dirs", "subdir", "--reporter", "junit"}, 0},
+		{"bad path", []string{"--search_path", "/path/does/not/exit"}, 1},
+		//{"exclude file types set", []string{"--exclude-file-types", "json"}, 0},
+		{"multiple paths", []string{"../../../test/fixtures/subdir/good.json", "../../../test/fixtures/good.json"}, 0},
+		{"output set", []string{"--output", "../../../test/output", "--reporter", "json"}, 0},
+		{"empty string output set", []string{"--output", "", "--reporter", "json", "."}, 0},
+		{"wrong output set", []string{"--output", "/path/not/exist", "--reporter", "json", "."}, 1},
+		{"incorrect group", []string{"--groupby", "badgroup"}, 1},
+		{"correct group", []string{"--groupby", "directory"}, 0},
+	}
+
+	var exitStatus int
+
+	for _, tc := range cases {
+		fmt.Printf("Testing args: %v = %v\n", tc.Name, tc.Args)
+		root := &cobra.Command{
+			Use: "root",
+			Run: func(c *cobra.Command, args []string) {
+				exitStatus = cmd.ExecRoot(c)
+			},
+		}
+		CmdFlags(root)
+
+		_, err := ExecuteTestHelper(t, root, tc.Args...)
+		if err != nil {
+			t.Error(err)
+		}
+
+		if tc.ExpectedExit != exitStatus {
+			t.Errorf("Wrong exit code, expected: %v, got: %v", tc.ExpectedExit, exitStatus)
+		}
+	}
+}