feat(alzlibtool): offline mode for library checks (#223)

Author: matt-FFFFFF

cmd/alzlibtool/command/check/library.go

@@ -24,21 +24,30 @@ var libraryCmd = cobra.Command{
 	Args:  cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		az := alzlib.NewAlzLib(nil)
-		creds, err := auth.NewToken()
+		offline, err := cmd.Flags().GetBool("offline")
 		if err != nil {
-			cmd.PrintErrf("%s could not get Azure credential: %v\n", cmd.ErrPrefix(), err)
+			cmd.PrintErrf("%s could not get offline flag: %v\n", cmd.ErrPrefix(), err)
 			os.Exit(1)
 		}
-		cf, err := armpolicy.NewClientFactory("", creds, &arm.ClientOptions{
-			ClientOptions: policy.ClientOptions{
-				Cloud: auth.GetCloudFromEnv(),
-			},
-		})
-		if err != nil {
-			cmd.PrintErrf("%s could not create Azure policy client factory: %v\n", cmd.ErrPrefix(), err)
-			os.Exit(1)
+
+		if !offline {
+			creds, err := auth.NewToken()
+			if err != nil {
+				cmd.PrintErrf("%s could not get Azure credential: %v\n", cmd.ErrPrefix(), err)
+				os.Exit(1)
+			}
+			cf, err := armpolicy.NewClientFactory("", creds, &arm.ClientOptions{
+				ClientOptions: policy.ClientOptions{
+					Cloud: auth.GetCloudFromEnv(),
+				},
+			})
+			if err != nil {
+				cmd.PrintErrf("%s could not create Azure policy client factory: %v\n", cmd.ErrPrefix(), err)
+				os.Exit(1)
+			}
+			az.AddPolicyClient(cf)
 		}
-		az.AddPolicyClient(cf)
+
 		thisRef := alzlib.NewCustomLibraryReference(args[0])
 		libs, err := thisRef.FetchWithDependencies(cmd.Context())
 		if err != nil {
@@ -63,13 +72,19 @@ var libraryCmd = cobra.Command{
 
 		chk := checker.NewValidator(
 			checks.CheckAllDefinitionsAreReferenced(az),
-			checks.CheckAllArchitectures(az),
 			checks.CheckLibraryMemberPath(az),
 			checks.CheckDefaults(az),
 			checks.CheckLibraryFileNames(args[0], &checks.CheckLibraryFileNameOptions{
 				Fix: shouldFix,
 			}),
 		)
+
+		if !offline {
+			chk = chk.AddChecks(
+				checks.CheckAllArchitectures(az),
+			)
+		}
+
 		err = chk.Validate()
 		if err != nil {
 			cmd.PrintErrf("%s library check error: %v\n", cmd.ErrPrefix(), err)
@@ -82,4 +97,6 @@ func init() {
 	libraryCmd.Flags().
 		BoolP("fix", "f", false,
 			"Whether to fix any fixable issues (currently only filename issues).")
+	libraryCmd.Flags().
+		Bool("offline", false, "Whether to run the checks in offline mode (no Azure calls).")
 }

internal/tools/checker/checker.go

@@ -13,6 +13,7 @@ import (
 // Validator is a struct that holds a list of checks to be performed.
 type Validator struct {
 	checks []ValidatorCheck
+	quiet  bool // whether to suppress check start/finish messages
 }
 
 // ValidatorCheck is a struct that holds the name and function of a check to be performed.
@@ -41,6 +42,14 @@ func NewValidator(c ...ValidatorCheck) Validator {
 	}
 }
 
+// NewValidatorQuiet creates a new Validator with the given checks, which suppresses check start/finish messages.
+func NewValidatorQuiet(c ...ValidatorCheck) Validator {
+	return Validator{
+		checks: c,
+		quiet:  true,
+	}
+}
+
 // AddChecks adds additional checks to the Validator.
 func (v Validator) AddChecks(c ...ValidatorCheck) Validator {
 	v.checks = append(v.checks, c...)
@@ -52,13 +61,17 @@ func (v Validator) Validate() error {
 	var errs error
 
 	for _, c := range v.checks {
-		io.WriteString(os.Stdout, "==> Starting check: "+c.name+"\n") // nolint: errcheck
+		if !v.quiet {
+			io.WriteString(os.Stdout, "==> Starting check: "+c.name+"\n") // nolint: errcheck
+		}
 
 		if err := c.f(); err != nil {
 			errs = multierror.Append(errs, err)
 		}
 
-		io.WriteString(os.Stdout, "==> Finished check: "+c.name+"\n") // nolint: errcheck
+		if !v.quiet {
+			io.WriteString(os.Stdout, "==> Finished check: "+c.name+"\n") // nolint: errcheck
+		}
 	}
 
 	return errs

internal/tools/checks/checkLibraryFileNames.go

@@ -20,7 +20,7 @@ import (
 )
 
 const (
-	versionlessLibraryFileNameParts = 3
+	versionlessLibraryFileNameParts = 3 // name.type.ext (no version segment), e.g. myRoleDef.alz_role_definition.json
 )
 
 // libraryFileNameCheckModel is a model for checking library file names.
@@ -37,7 +37,7 @@ type libraryFileNameCheckModelProperties struct {
 }
 
 func (m *libraryFileNameCheckModel) check(p libraryFileNameParts) error {
-	v := checker.NewValidator(
+	v := checker.NewValidatorQuiet(
 		checkType(m, p),
 		checkName(m, p),
 		checkVersion(m, p),