feat: Bypass cft test lint rules (#2669)

Co-authored-by: Zheng Qin <[email protected]>
Co-authored-by: Bharath KKB <[email protected]>

cli/bptest/lint_interface.go

@@ -1,7 +1,9 @@
 package bptest
 
 import (
+	"fmt"
 	"github.com/GoogleCloudPlatform/cloud-foundation-toolkit/cli/bpmetadata"
+	"os"
 )
 
 // lintRule defines the common interface for all metadata lint rules.
@@ -30,6 +32,11 @@ func (r *lintRunner) RegisterRule(rule lintRule) {
 // Run runs all the registered rules on the provided context.
 func (r *lintRunner) Run(ctx lintContext) []error {
 	var errs []error
+	if os.Getenv("BLUEPRINT_LINT_DISABLE") == "1" {
+		fmt.Println("BLUEPRINT_LINT_DISABLE is set to 1. Skipping lint checks.")
+		return errs
+	}
+
 	for _, rule := range r.rules {
 		if rule.enabled() {
 			err := rule.check(ctx)

cli/bptest/lint_interface_test.go

@@ -0,0 +1,82 @@
+package bptest
+
+import (
+	"errors"
+	"os"
+	"testing"
+
+	"github.com/GoogleCloudPlatform/cloud-foundation-toolkit/cli/bpmetadata"
+	"github.com/stretchr/testify/assert"
+)
+
+const BlueprintLintDisableEnv = "BLUEPRINT_LINT_DISABLE"
+
+type mockLintRule struct {
+	Name    string
+	Enabled bool
+	Err     error
+}
+
+func (m *mockLintRule) name() string {
+	return m.Name
+}
+
+func (m *mockLintRule) enabled() bool {
+	return m.Enabled
+}
+
+func (m *mockLintRule) check(ctx lintContext) error {
+	return m.Err
+}
+
+func TestLintRunner(t *testing.T) {
+	t.Run("register and run rules with lintRunner", func(t *testing.T) {
+		mockRule1 := &mockLintRule{Name: "MockRule1", Enabled: true, Err: nil}
+		mockRule2 := &mockLintRule{Name: "MockRule2", Enabled: true, Err: errors.New("lint error")}
+		mockRule3 := &mockLintRule{Name: "MockRule3", Enabled: false, Err: nil}
+
+		runner := lintRunner{}
+		runner.RegisterRule(mockRule1)
+		runner.RegisterRule(mockRule2)
+		runner.RegisterRule(mockRule3)
+
+		ctx := lintContext{
+			metadata: &bpmetadata.BlueprintMetadata{ApiVersion: "v1", Kind: "Blueprint"},
+			filePath: "/path/to/metadata/file.yaml",
+		}
+
+		errs := runner.Run(ctx)
+		assert.Len(t, errs, 1, "Only one rule should return an error")
+		assert.Equal(t, "lint error", errs[0].Error(), "Error message should match the expected lint error")
+	})
+
+	t.Run("run without registered rules", func(t *testing.T) {
+		runner := lintRunner{}
+		ctx := lintContext{
+			metadata: &bpmetadata.BlueprintMetadata{ApiVersion: "v1", Kind: "Blueprint"},
+			filePath: "/path/to/metadata/file.yaml",
+		}
+
+		errs := runner.Run(ctx)
+		assert.Empty(t, errs, "No errors should be returned when no rules are registered")
+	})
+	t.Run("skip lint rules when BLUEPRINT_LINT_DISABLE is set", func(t *testing.T) {
+		os.Setenv(BlueprintLintDisableEnv, "1")
+		defer os.Unsetenv(BlueprintLintDisableEnv)
+
+		mockRule1 := &mockLintRule{Name: "MockRule1", Enabled: true, Err: errors.New("lint error")}
+		mockRule2 := &mockLintRule{Name: "MockRule2", Enabled: true, Err: errors.New("another lint error")}
+
+		runner := lintRunner{}
+		runner.RegisterRule(mockRule1)
+		runner.RegisterRule(mockRule2)
+
+		ctx := lintContext{
+			metadata: &bpmetadata.BlueprintMetadata{ApiVersion: "v1", Kind: "Blueprint"},
+			filePath: "/path/to/metadata/file.yaml",
+		}
+
+		errs := runner.Run(ctx)
+		assert.Empty(t, errs, "No errors should be returned when BLUEPRINT_LINT_DISABLE is set")
+	})
+}