chore: generate Go boilerplate to disable logging in tests.

Signed-off-by: i4k <[email protected]>

.github/workflows/ci-sync-preview.yml

@@ -51,6 +51,9 @@ jobs:
           terraform_version: "1.7.5"
           terraform_wrapper: false
 
+      - name: show event file
+        run: cat $GITHUB_EVENT_PATH
+
       - name: Install Terramate
         uses: terramate-io/terramate-action@i4k-fix-macos
         env:

cloud/deployment/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package deployment_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

cloud/drift/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package drift_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

e2etests/cloud/loglevel_test.go → cloud/loglevel_disable_test.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Terramate GmbH
+// Copyright 2024 Terramate GmbH
 // SPDX-License-Identifier: MPL-2.0
 
 package cloud_test

cloud/preview/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package preview_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

stack/loglevel_test.go → cloud/stack/loglevel_disable_test.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Terramate GmbH
+// Copyright 2024 Terramate GmbH
 // SPDX-License-Identifier: MPL-2.0
 
 package stack_test

cloud/testserver/cloudstore/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package cloudstore_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

cloud/testserver/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package testserver_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

cmd/terramate/cli/cliconfig/cliconfig_test.go

@@ -7,7 +7,6 @@ import (
 	"testing"
 
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/cmd/terramate/cli/cliconfig"
 	"github.com/terramate-io/terramate/errors"
 	"github.com/terramate-io/terramate/hcl"
@@ -158,7 +157,3 @@ func TestLoad(t *testing.T) {
 		})
 	}
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

loglevel_test.go → cmd/terramate/cli/cliconfig/loglevel_disable_test.go

@@ -1,7 +1,7 @@
-// Copyright 2023 Terramate GmbH
+// Copyright 2024 Terramate GmbH
 // SPDX-License-Identifier: MPL-2.0
 
-package terramate_test
+package cliconfig_test
 
 import "github.com/rs/zerolog"
 

cmd/terramate/cli/github/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package github_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

cmd/terramate/cli/gitlab/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package gitlab_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

cmd/terramate/cli/out/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package out_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

config/config_test.go

@@ -9,7 +9,6 @@ import (
 	"testing"
 
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/config"
 	"github.com/terramate-io/terramate/errors"
 	"github.com/terramate-io/terramate/project"
@@ -333,7 +332,3 @@ func TestConfigSkipdir(t *testing.T) {
 func isStack(root *config.Root, dir string) bool {
 	return config.IsStack(root, filepath.Join(root.HostDir(), dir))
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

config/filter/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package filter_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

config/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package config_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

e2etests/cloud/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package cloud_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

e2etests/core/disable_loglevel_test.go → e2etests/core/loglevel_disable_test.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Terramate GmbH
+// Copyright 2024 Terramate GmbH
 // SPDX-License-Identifier: MPL-2.0
 
 package core_test

errors/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package errors_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

event/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package event_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

fs/copy_test.go

@@ -9,7 +9,6 @@ import (
 	"testing"
 
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/fs"
 	"github.com/terramate-io/terramate/test"
 	"github.com/terramate-io/terramate/test/sandbox"
@@ -56,7 +55,3 @@ func TestCopyIfAllFilesAreFilteredDirIsNotCreated(t *testing.T) {
 		}
 	}
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

fs/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package fs_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

generate/generate_test.go

@@ -13,7 +13,6 @@ import (
 	"testing"
 
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/config"
 	"github.com/terramate-io/terramate/errors"
 	"github.com/terramate-io/terramate/generate"
@@ -1201,7 +1200,3 @@ func assertEqualStringList(t *testing.T, got []string, want []string) {
 		t.Fatalf("got %v != want %v", got, want)
 	}
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

generate/genfile/genfile_test.go

@@ -8,7 +8,6 @@ import (
 	"testing"
 
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/config"
 	"github.com/terramate-io/terramate/errors"
 	"github.com/terramate-io/terramate/generate/genfile"
@@ -1020,7 +1019,3 @@ func testGenfile(t *testing.T, tcase testcase) {
 		}
 	})
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

generate/genfile/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package genfile_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

generate/genhcl/genhcl_test.go

@@ -11,7 +11,6 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/config"
 	"github.com/terramate-io/terramate/errors"
 	"github.com/terramate-io/terramate/generate/genhcl"
@@ -1956,7 +1955,3 @@ func assertHCLEquals(t *testing.T, got string, want string) {
 		t.Fatalf("diff:\n%s", diff)
 	}
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

generate/genhcl/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package genhcl_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

generate/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package generate_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}

generate_golang.tm

@@ -0,0 +1,38 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+globals {
+  # you can enable this only in the stack you are debugging the tests.
+  enable_test_logging = false
+
+  is_go_package = tm_anytrue([
+    tm_contains(terramate.stack.tags, "golang"),
+    tm_contains(terramate.stack.tags, "e2etests"),
+  ])
+  has_test_files = tm_length(tm_fileset(".", "*_test.go")) > 0
+}
+
+generate_file "loglevel_disable_test.go" {
+  condition = !global.enable_test_logging && global.is_go_package && global.has_test_files
+  lets {
+    special_cases = {
+      "ls" = "tmls"
+      "/"  = "terramate"
+    }
+    is_main  = tm_can(tm_file("main.go"))
+    basename = terramate.stack.path.basename
+    pkgname  = let.is_main ? "main" : tm_try(let.special_cases[let.basename], let.basename)
+  }
+  content = <<-EOF
+      // Copyright 2024 Terramate GmbH
+      // SPDX-License-Identifier: MPL-2.0
+
+      package ${let.pkgname}_test
+
+      import "github.com/rs/zerolog"
+
+      func init() {
+      	zerolog.SetGlobalLevel(zerolog.Disabled)
+      }
+    EOF
+}

generate_preview.tm → generate_mock_preview.tm

@@ -4,10 +4,7 @@
 // This file is required by the "preview" script.
 
 generate_hcl "_test_mock.tf" {
-  condition = tm_anytrue([
-    tm_contains(terramate.stack.tags, "golang"),
-    tm_contains(terramate.stack.tags, "e2etests"),
-  ])
+  condition = global.is_go_package
   lets {
     name = tm_ternary(terramate.stack.path.basename == "/", "terramate", terramate.stack.path.basename)
   }

git/git_test.go

@@ -14,7 +14,6 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/madlambda/spells/assert"
-	"github.com/rs/zerolog"
 	"github.com/terramate-io/terramate/git"
 	"github.com/terramate-io/terramate/test"
 	"github.com/terramate-io/terramate/test/sandbox"
@@ -522,7 +521,3 @@ func assertEqualRemotes(t *testing.T, got []git.Remote, want []git.Remote) {
 		)
 	}
 }
-
-func init() {
-	zerolog.SetGlobalLevel(zerolog.Disabled)
-}

git/loglevel_disable_test.go

@@ -0,0 +1,10 @@
+// Copyright 2024 Terramate GmbH
+// SPDX-License-Identifier: MPL-2.0
+
+package git_test
+
+import "github.com/rs/zerolog"
+
+func init() {
+	zerolog.SetGlobalLevel(zerolog.Disabled)
+}