feat: restructure cmd folder

Dividing the cmd folder structure into exp and core commands. Commands that are within the exp folder are not tested 'at all' - and we most likely do not have the infrastructure to test it. Commands in the core folder have a better chance to get tested. Signed-off-by: Christian Walter <[email protected]>
9elements · Mar 23, 2024 · 4fbe684 · 4fbe684
1 parent 8e176a0
commit 4fbe684
Show file tree

Hide file tree

Showing 42 changed files with 27 additions and 27 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -19,17 +19,17 @@ jobs:
             - name: Checkout
               uses: actions/checkout@v4
             - name: Build txt-suite
-              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o txt-suite cmd/txt-suite/*.go
+              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o txt-suite cmd/core/txt-suite/*.go
             - name: Build txt-prov
-              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o txt-prov cmd/txt-prov/*.go
+              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o txt-prov cmd/core/txt-prov/*.go
             - name: Build bg-suite
-              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o bg-suite cmd/bg-suite/*.go
+              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o bg-suite cmd/core/bg-suite/*.go
             - name: Build bg-prov
-              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o bg-prov cmd/bg-prov/*.go
+              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o bg-prov cmd/core/bg-prov/*.go
             - name: Build pcr0tool
-              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o pcr0tool cmd/pcr0tool/*.go
+              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o pcr0tool cmd/exp/pcr0tool/*.go
             - name: Build amd-suite
-              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o amd-suite cmd/amd-suite/*.go
+              run: go build -ldflags '-X main.gitcommit=${GITHUB_SHA} -X main.gittag=${github.ref_name} -w -extldflags "-static"' -o amd-suite cmd/exp/amd-suite/*.go
             - name: Save artifacts
               uses: actions/upload-artifact@v4
               with:

diff --git a/cmd/bg-prov/README.md → cmd/core/bg-prov/README.md b/cmd/bg-prov/README.md → cmd/core/bg-prov/README.md
diff --git a/cmd/bg-prov/cmd.go → cmd/core/bg-prov/cmd.go b/cmd/bg-prov/cmd.go → cmd/core/bg-prov/cmd.go
diff --git a/cmd/bg-prov/main.go → cmd/core/bg-prov/main.go b/cmd/bg-prov/main.go → cmd/core/bg-prov/main.go
diff --git a/cmd/bg-suite/README.md → cmd/core/bg-suite/README.md b/cmd/bg-suite/README.md → cmd/core/bg-suite/README.md
diff --git a/cmd/bg-suite/TESTPLAN.md → cmd/core/bg-suite/TESTPLAN.md b/cmd/bg-suite/TESTPLAN.md → cmd/core/bg-suite/TESTPLAN.md
diff --git a/cmd/bg-suite/cmd.go → cmd/core/bg-suite/cmd.go b/cmd/bg-suite/cmd.go → cmd/core/bg-suite/cmd.go
diff --git a/cmd/bg-suite/main.go → cmd/core/bg-suite/main.go b/cmd/bg-suite/main.go → cmd/core/bg-suite/main.go
diff --git a/cmd/txt-prov/README.md → cmd/core/txt-prov/README.md b/cmd/txt-prov/README.md → cmd/core/txt-prov/README.md
diff --git a/cmd/txt-prov/cmd.go → cmd/core/txt-prov/cmd.go b/cmd/txt-prov/cmd.go → cmd/core/txt-prov/cmd.go
diff --git a/cmd/txt-prov/config.go → cmd/core/txt-prov/config.go b/cmd/txt-prov/config.go → cmd/core/txt-prov/config.go
diff --git a/cmd/txt-prov/lcp.json → cmd/core/txt-prov/lcp.json b/cmd/txt-prov/lcp.json → cmd/core/txt-prov/lcp.json
diff --git a/cmd/txt-prov/main.go → cmd/core/txt-prov/main.go b/cmd/txt-prov/main.go → cmd/core/txt-prov/main.go
diff --git a/cmd/txt-prov/tools.go → cmd/core/txt-prov/tools.go b/cmd/txt-prov/tools.go → cmd/core/txt-prov/tools.go
diff --git a/cmd/txt-suite/README.md → cmd/core/txt-suite/README.md b/cmd/txt-suite/README.md → cmd/core/txt-suite/README.md
diff --git a/cmd/txt-suite/TESTPLAN.md → cmd/core/txt-suite/TESTPLAN.md b/cmd/txt-suite/TESTPLAN.md → cmd/core/txt-suite/TESTPLAN.md
diff --git a/cmd/txt-suite/cmd.go → cmd/core/txt-suite/cmd.go b/cmd/txt-suite/cmd.go → cmd/core/txt-suite/cmd.go
diff --git a/cmd/txt-suite/main.go → cmd/core/txt-suite/main.go b/cmd/txt-suite/main.go → cmd/core/txt-suite/main.go
diff --git a/cmd/amd-suite/cmd.go → cmd/exp/amd-suite/cmd.go b/cmd/amd-suite/cmd.go → cmd/exp/amd-suite/cmd.go
diff --git a/cmd/amd-suite/main.go → cmd/exp/amd-suite/main.go b/cmd/amd-suite/main.go → cmd/exp/amd-suite/main.go
diff --git a/cmd/amd-suite/parse_amd_firmware_file.go → cmd/exp/amd-suite/parse_amd_firmware_file.go b/cmd/amd-suite/parse_amd_firmware_file.go → cmd/exp/amd-suite/parse_amd_firmware_file.go
diff --git a/cmd/pcr0tool/README.md → cmd/exp/pcr0tool/README.md b/cmd/pcr0tool/README.md → cmd/exp/pcr0tool/README.md
diff --git a/...s/bruteforce_acm_policy_status/command.go → ...s/bruteforce_acm_policy_status/command.go b/...s/bruteforce_acm_policy_status/command.go → ...s/bruteforce_acm_policy_status/command.go
@@ -11,8 +11,8 @@ import (
 	"hash"
 	"os"
 
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/dumpregisters/helpers"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/dumpregisters/helpers"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/actions/tpmactions"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/bootengine"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/datasources"

diff --git a/cmd/pcr0tool/commands/command.go → cmd/exp/pcr0tool/commands/command.go b/cmd/pcr0tool/commands/command.go → cmd/exp/pcr0tool/commands/command.go
diff --git a/cmd/pcr0tool/commands/common.go → cmd/exp/pcr0tool/commands/common.go b/cmd/pcr0tool/commands/common.go → cmd/exp/pcr0tool/commands/common.go
diff --git a/cmd/pcr0tool/commands/diff/command.go → cmd/exp/pcr0tool/commands/diff/command.go b/cmd/pcr0tool/commands/diff/command.go → cmd/exp/pcr0tool/commands/diff/command.go
@@ -16,9 +16,9 @@ import (
 	pkgbytes "github.com/linuxboot/fiano/pkg/bytes"
 	fianoUEFI "github.com/linuxboot/fiano/pkg/uefi"
 
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/diff/format"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/dumpregisters/helpers"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/diff/format"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/dumpregisters/helpers"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/bootengine"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/flows"
 	bfformat "github.com/9elements/converged-security-suite/v2/pkg/bootflow/lib/format"

diff --git a/cmd/pcr0tool/commands/diff/format/format.go → ...p/pcr0tool/commands/diff/format/format.go b/cmd/pcr0tool/commands/diff/format/format.go → ...p/pcr0tool/commands/diff/format/format.go
diff --git a/...0tool/commands/displayeventlog/command.go → ...0tool/commands/displayeventlog/command.go b/...0tool/commands/displayeventlog/command.go → ...0tool/commands/displayeventlog/command.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/displayeventlog/format"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/displayeventlog/format"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/subsystems/trustchains/tpm/pcr"
 	"github.com/9elements/converged-security-suite/v2/pkg/tpmeventlog"
 )

diff --git a/...l/commands/displayeventlog/flag_format.go → ...l/commands/displayeventlog/flag_format.go b/...l/commands/displayeventlog/flag_format.go → ...l/commands/displayeventlog/flag_format.go
diff --git a/...mands/displayeventlog/format/event_log.go → ...mands/displayeventlog/format/event_log.go b/...mands/displayeventlog/format/event_log.go → ...mands/displayeventlog/format/event_log.go
diff --git a/...cr0tool/commands/displayfwinfo/command.go → ...cr0tool/commands/displayfwinfo/command.go b/...cr0tool/commands/displayfwinfo/command.go → ...cr0tool/commands/displayfwinfo/command.go
diff --git a/cmd/pcr0tool/commands/dumpfit/command.go → cmd/exp/pcr0tool/commands/dumpfit/command.go b/cmd/pcr0tool/commands/dumpfit/command.go → cmd/exp/pcr0tool/commands/dumpfit/command.go
diff --git a/...cr0tool/commands/dumpregisters/command.go → ...cr0tool/commands/dumpregisters/command.go b/...cr0tool/commands/dumpregisters/command.go → ...cr0tool/commands/dumpregisters/command.go
@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/dumpregisters/helpers"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/dumpregisters/helpers"
 	"github.com/9elements/converged-security-suite/v2/pkg/registers"
 
 	"gopkg.in/yaml.v3"
@@ -70,7 +70,7 @@ func (cmd Command) Execute(ctx context.Context, args []string) {
 		if err != nil {
 			panic(fmt.Sprintf("failed to marshal registers into json, err: %v", err))
 		}
-		err = os.WriteFile(*cmd.outputFile, b, 0666)
+		err = os.WriteFile(*cmd.outputFile, b, 0o666)
 		if err != nil {
 			panic(fmt.Sprintf("failed to write data to file %s, err: %v", *cmd.outputFile, err))
 		}

diff --git a/...s/dumpregisters/helpers/flag_registers.go → ...s/dumpregisters/helpers/flag_registers.go b/...s/dumpregisters/helpers/flag_registers.go → ...s/dumpregisters/helpers/flag_registers.go
diff --git a/...ds/dumpregisters/helpers/get_registers.go → ...ds/dumpregisters/helpers/get_registers.go b/...ds/dumpregisters/helpers/get_registers.go → ...ds/dumpregisters/helpers/get_registers.go
diff --git a/.../dumpregisters/helpers/print_registers.go → .../dumpregisters/helpers/print_registers.go b/.../dumpregisters/helpers/print_registers.go → .../dumpregisters/helpers/print_registers.go
diff --git a/cmd/pcr0tool/commands/pcrread/command.go → cmd/exp/pcr0tool/commands/pcrread/command.go b/cmd/pcr0tool/commands/pcrread/command.go → cmd/exp/pcr0tool/commands/pcrread/command.go
diff --git a/cmd/pcr0tool/commands/printnodes/command.go → ...p/pcr0tool/commands/printnodes/command.go b/cmd/pcr0tool/commands/printnodes/command.go → ...p/pcr0tool/commands/printnodes/command.go
diff --git a/cmd/pcr0tool/commands/sum/command.go → cmd/exp/pcr0tool/commands/sum/command.go b/cmd/pcr0tool/commands/sum/command.go → cmd/exp/pcr0tool/commands/sum/command.go
@@ -10,8 +10,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/dumpregisters/helpers"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/dumpregisters/helpers"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/bootengine"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/flows"
 	"github.com/9elements/converged-security-suite/v2/pkg/bootflow/lib/format"

diff --git a/...date_security/inject_benign_corruption.go → ...date_security/inject_benign_corruption.go b/...date_security/inject_benign_corruption.go → ...date_security/inject_benign_corruption.go
diff --git a/...r0tool/commands/validate_security/main.go → ...r0tool/commands/validate_security/main.go b/...r0tool/commands/validate_security/main.go → ...r0tool/commands/validate_security/main.go
diff --git a/cmd/pcr0tool/main.go → cmd/exp/pcr0tool/main.go b/cmd/pcr0tool/main.go → cmd/exp/pcr0tool/main.go
@@ -7,17 +7,17 @@ import (
 	"os"
 	"sort"
 
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands"
-	bruteforceacmpolicystatus "github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/bruteforce_acm_policy_status"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/diff"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/displayeventlog"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/displayfwinfo"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/dumpfit"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/dumpregisters"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/pcrread"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/printnodes"
-	"github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/sum"
-	validatesecurity "github.com/9elements/converged-security-suite/v2/cmd/pcr0tool/commands/validate_security"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands"
+	bruteforceacmpolicystatus "github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/bruteforce_acm_policy_status"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/diff"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/displayeventlog"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/displayfwinfo"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/dumpfit"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/dumpregisters"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/pcrread"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/printnodes"
+	"github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/sum"
+	validatesecurity "github.com/9elements/converged-security-suite/v2/cmd/exp/pcr0tool/commands/validate_security"
 	"github.com/9elements/converged-security-suite/v2/pkg/log"
 	"github.com/facebookincubator/go-belt/tool/logger"
 	"github.com/facebookincubator/go-belt/tool/logger/implementation/logrus"