Merge pull request #534 from magodo/slog

Changing the logger type to `slog.Logger`

Author: magodo

.github/workflows/codeql.yml

@@ -34,7 +34,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v1
       with:
-        go-version: 1.19
+        go-version: 1.22
 
     - name: Build 
       run: |

.github/workflows/pr.yaml

@@ -8,8 +8,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v1
         with:
-          go-version: 1.19
-
+          go-version: 1.22
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2
 
@@ -22,10 +21,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Source
-        uses: actions/checkout@v2
-
+        uses: actions/checkout@v3
       - name: Run Gosec Security Scanner
-        uses: securego/gosec@v2.16.0
+        uses: securego/gosec@2ae137abcf405533ad6e549e9363e58e4f6e8b7d
         with:
           args: './...'
 
@@ -36,7 +34,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v1
         with:
-          go-version: 1.19
+          go-version: 1.22
 
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2

flag.go

@@ -3,7 +3,6 @@ package main
 import (
 	"fmt"
 	"os"
-	"os/exec"
 	"strings"
 
 	"github.com/Azure/aztfexport/internal/cfgfile"
@@ -15,8 +14,6 @@ import (
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
 	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
 	"github.com/gofrs/uuid"
-	"github.com/hashicorp/go-hclog"
-	"github.com/magodo/terraform-client-go/tfclient"
 	"github.com/urfave/cli/v2"
 )
 
@@ -335,6 +332,7 @@ func buildAzureSDKCredAndClientOpt(fset FlagSet) (azcore.TokenCredential, *arm.C
 	}
 }
 
+// BuildCommonConfig builds the CommonConfig from the FlagSet, except the TFClient, which is built afterwards as it requires a logger.
 func (f FlagSet) BuildCommonConfig() (config.CommonConfig, error) {
 	cred, clientOpt, err := buildAzureSDKCredAndClientOpt(f)
 	if err != nil {
@@ -369,17 +367,5 @@ func (f FlagSet) BuildCommonConfig() (config.CommonConfig, error) {
 		}
 	}
 
-	if f.hflagTFClientPluginPath != "" {
-		// #nosec G204
-		tfc, err := tfclient.New(tfclient.Option{
-			Cmd:    exec.Command(flagset.hflagTFClientPluginPath),
-			Logger: hclog.NewNullLogger(),
-		})
-		if err != nil {
-			return cfg, err
-		}
-		cfg.TFClient = tfc
-	}
-
 	return cfg, nil
 }

go.mod

@@ -1,6 +1,6 @@
 module github.com/Azure/aztfexport
 
-go 1.19
+go 1.21
 
 require (
 	github.com/Azure/azure-sdk-for-go/sdk/azcore v1.9.0
@@ -11,7 +11,7 @@ require (
 	github.com/charmbracelet/bubbletea v0.22.1
 	github.com/charmbracelet/lipgloss v0.5.0
 	github.com/gofrs/uuid v3.3.0+incompatible
-	github.com/hashicorp/go-hclog v1.3.1
+	github.com/hashicorp/go-hclog v1.6.3
 	github.com/hashicorp/go-version v1.6.0
 	github.com/hashicorp/hc-install v0.6.2
 	github.com/hashicorp/hcl/v2 v2.17.0
@@ -20,8 +20,9 @@ require (
 	github.com/hashicorp/terraform-json v0.19.0
 	github.com/hexops/gotextdiff v1.0.3
 	github.com/magodo/armid v0.0.0-20230511151020-27880e5961c3
-	github.com/magodo/azlist v0.0.0-20231101012443-e30f2da262c1
+	github.com/magodo/azlist v0.0.0-20240613024003-b4529218cc6a
 	github.com/magodo/aztft v0.3.1-0.20240429022627-002cdc06267a
+	github.com/magodo/slog2hclog v0.0.0-20240614031327-090ebd72a033
 	github.com/magodo/spinner v0.0.0-20220720073946-50f31b2dc5a6
 	github.com/magodo/terraform-client-go v0.0.0-20230323074119-02ceb732dd25
 	github.com/magodo/textinput v0.0.0-20210913072708-7d24f2b4b0c0

go.sum

@@ -298,7 +298,7 @@ func (meta *baseMeta) ParallelImport(ctx context.Context, items []*ImportItem) e
 		// Ensure the state file is removed after this round import, preparing for the next round.
 		defer os.Remove(stateFile)
 
-		log.Printf("[DEBUG] Merging terraform state file %s (tfmerge)", stateFile)
+		log.Debug("Merging terraform state file (tfmerge)", "file", stateFile)
 		newState, err := tfmerge.Merge(ctx, meta.tf, meta.baseState, stateFile)
 		if err != nil {
 			return fmt.Errorf("failed to merge state file: %v", err)
@@ -667,12 +667,12 @@ func (meta *baseMeta) initImportDirs() error {
 }
 
 func (meta *baseMeta) initTF(ctx context.Context) error {
-	log.Printf("[INFO] Init Terraform")
+	log.Info("Init Terraform")
 	execPath, err := FindTerraform(ctx)
 	if err != nil {
 		return fmt.Errorf("error finding a terraform exectuable: %w", err)
 	}
-	log.Printf("[INFO] Find terraform binary at %s", execPath)
+	log.Info("Found terraform binary", "path", execPath)
 
 	newTF := func(dir string) (*tfexec.Terraform, error) {
 		tf, err := tfexec.NewTerraform(dir, execPath)
@@ -708,7 +708,7 @@ func (meta *baseMeta) initTF(ctx context.Context) error {
 }
 
 func (meta *baseMeta) initProvider(ctx context.Context) error {
-	log.Printf("[INFO] Init provider")
+	log.Info("Init provider")
 
 	module, diags := tfconfig.LoadModule(meta.outdir)
 	if diags.HasErrors() {
@@ -721,7 +721,7 @@ func (meta *baseMeta) initProvider(ctx context.Context) error {
 	}
 
 	if module.ProviderConfigs[meta.providerName] == nil {
-		log.Printf("[INFO] Output directory doesn't contain provider setting, create one then")
+		log.Info("Output directory doesn't contain provider setting, create one then")
 		cfgFile := filepath.Join(meta.outdir, meta.outputFileNames.ProviderFileName)
 		// #nosec G306
 		if err := os.WriteFile(cfgFile, []byte(meta.buildProviderConfig()), 0644); err != nil {
@@ -730,7 +730,7 @@ func (meta *baseMeta) initProvider(ctx context.Context) error {
 	}
 
 	if tfblock == nil {
-		log.Printf("[INFO] Output directory doesn't contain terraform block, create one then")
+		log.Info("Output directory doesn't contain terraform block, create one then")
 		cfgFile := filepath.Join(meta.outdir, meta.outputFileNames.TerraformFileName)
 		// #nosec G306
 		if err := os.WriteFile(cfgFile, []byte(meta.buildTerraformConfig(meta.backendType)), 0644); err != nil {
@@ -744,7 +744,7 @@ func (meta *baseMeta) initProvider(ctx context.Context) error {
 		opts = append(opts, tfexec.BackendConfig(opt))
 	}
 
-	log.Printf(`[DEBUG] Run "terraform init" for the output directory %s`, meta.outdir)
+	log.Debug(`Run "terraform init" for the output directory`, "dir", meta.outdir)
 	if err := meta.tf.Init(ctx, opts...); err != nil {
 		return fmt.Errorf("error running terraform init for the output directory: %s", err)
 	}
@@ -766,9 +766,9 @@ func (meta *baseMeta) initProvider(ctx context.Context) error {
 				return nil, fmt.Errorf("error creating terraform config: %w", err)
 			}
 			if meta.devProvider {
-				log.Printf(`[DEBUG] Skip running "terraform init" for the import directory (dev provider): %s`, meta.importBaseDirs[i])
+				log.Debug(`Skip running "terraform init" for the import directory (dev provider)`, "dir", meta.importBaseDirs[i])
 			} else {
-				log.Printf(`[DEBUG] Run "terraform init" for the import directory %s`, meta.importBaseDirs[i])
+				log.Debug(`Run "terraform init" for the import directory`, "dir", meta.importBaseDirs[i])
 				if err := meta.importTFs[i].Init(ctx); err != nil {
 					return nil, fmt.Errorf("error running terraform init: %s", err)
 				}
@@ -785,7 +785,7 @@ func (meta *baseMeta) initProvider(ctx context.Context) error {
 
 func (meta *baseMeta) importItem(ctx context.Context, item *ImportItem, importIdx int) {
 	if item.Skip() {
-		log.Printf("[INFO] Skipping %s", item.TFResourceId)
+		log.Info("Skipping resource", "tf_id", item.TFResourceId)
 		return
 	}
 
@@ -807,7 +807,7 @@ func (meta *baseMeta) importItem_tf(ctx context.Context, item *ImportItem, impor
 	// #nosec G306
 	if err := os.WriteFile(cfgFile, []byte(tpl), 0644); err != nil {
 		err := fmt.Errorf("generating resource template file for %s: %w", item.TFAddr, err)
-		log.Printf("[ERROR] %v", err)
+		log.Error("Failed to generate resource template file", "error", err, "tf_addr", item.TFAddr)
 		item.ImportError = err
 		return
 	}
@@ -819,13 +819,13 @@ func (meta *baseMeta) importItem_tf(ctx context.Context, item *ImportItem, impor
 		addr = meta.moduleAddr + "." + addr
 	}
 
-	log.Printf("[INFO] Importing %s as %s", item.TFResourceId, addr)
+	log.Info("Importing a resource", "tf_id", item.TFResourceId, "tf_addr", addr)
 	// The actual resource type names in telemetry is redacted
 	meta.tc.Trace(telemetry.Info, fmt.Sprintf("Importing %s as %s", item.AzureResourceID.TypeString(), addr))
 
 	err := tf.Import(ctx, addr, item.TFResourceId)
 	if err != nil {
-		log.Printf("[ERROR] Importing %s: %v", item.TFAddr, err)
+		log.Error("Terraform import failed", "tf_addr", item.TFAddr, "error", err)
 		meta.tc.Trace(telemetry.Error, fmt.Sprintf("Importing %s failed", item.AzureResourceID.TypeString()))
 		meta.tc.Trace(telemetry.Error, fmt.Sprintf("Error detail: %v", err))
 	} else {
@@ -838,7 +838,7 @@ func (meta *baseMeta) importItem_tf(ctx context.Context, item *ImportItem, impor
 func (meta *baseMeta) importItem_notf(ctx context.Context, item *ImportItem, importIdx int) {
 	// Import resources
 	addr := item.TFAddr.String()
-	log.Printf("[INFO] Importing %s as %s", item.TFResourceId, addr)
+	log.Info("Importing a resource", "tf_id", item.TFResourceId, "tf_addr", addr)
 	// The actual resource type names in telemetry is redacted
 	meta.tc.Trace(telemetry.Info, fmt.Sprintf("Importing %s as %s", item.AzureResourceID.TypeString(), addr))
 
@@ -847,7 +847,7 @@ func (meta *baseMeta) importItem_notf(ctx context.Context, item *ImportItem, imp
 		ID:       item.TFResourceId,
 	})
 	if diags.HasErrors() {
-		log.Printf("[ERROR] Importing %s: %v", item.TFAddr, diags)
+		log.Error("Terraform import failed", "tf_addr", item.TFAddr, "error", diags.Err())
 		meta.tc.Trace(telemetry.Error, fmt.Sprintf("Importing %s failed", item.AzureResourceID.TypeString()))
 		meta.tc.Trace(telemetry.Error, fmt.Sprintf("Error detail: %v", diags.Err()))
 		item.ImportError = diags.Err()
@@ -856,7 +856,7 @@ func (meta *baseMeta) importItem_notf(ctx context.Context, item *ImportItem, imp
 	}
 	if len(importResp.ImportedResources) != 1 {
 		err := fmt.Errorf("expect 1 resource being imported, got=%d", len(importResp.ImportedResources))
-		log.Printf("[ERROR] %s", err)
+		log.Error(err.Error())
 		meta.tc.Trace(telemetry.Error, err.Error())
 		item.ImportError = err
 		item.Imported = false
@@ -869,7 +869,7 @@ func (meta *baseMeta) importItem_notf(ctx context.Context, item *ImportItem, imp
 		Private:    res.Private,
 	})
 	if diags.HasErrors() {
-		log.Printf("[ERROR] Reading %s: %v", item.TFAddr, diags)
+		log.Error("Terraform read a resource failed", "tf_addr", item.TFAddr, "error", diags.Err())
 		meta.tc.Trace(telemetry.Error, fmt.Sprintf("Reading %s failed", item.AzureResourceID.TypeString()))
 		meta.tc.Trace(telemetry.Error, fmt.Sprintf("Error detail: %v", diags.Err()))
 		item.ImportError = diags.Err()

internal/meta/base_meta.go

@@ -21,7 +21,7 @@ type MetaMap struct {
 }
 
 func NewMetaMap(cfg config.Config) (*MetaMap, error) {
-	log.Printf("[INFO] New map meta")
+	log.Info("New map meta")
 	baseMeta, err := NewBaseMeta(cfg.CommonConfig)
 	if err != nil {
 		return nil, err
@@ -42,7 +42,7 @@ func (meta MetaMap) ScopeName() string {
 func (meta *MetaMap) ListResource(_ context.Context) (ImportList, error) {
 	var m resmap.ResourceMapping
 
-	log.Printf("[DEBUG] Read resource set from mapping file")
+	log.Debug("Read resource set from mapping file")
 	b, err := os.ReadFile(meta.mappingFile)
 	if err != nil {
 		return nil, fmt.Errorf("reading mapping file %s: %v", meta.mappingFile, err)

internal/meta/meta_map.go

@@ -22,7 +22,7 @@ type MetaQuery struct {
 }
 
 func NewMetaQuery(cfg config.Config) (*MetaQuery, error) {
-	log.Printf("[INFO] New query meta")
+	log.Info("New query meta")
 	baseMeta, err := NewBaseMeta(cfg.CommonConfig)
 	if err != nil {
 		return nil, err
@@ -49,26 +49,26 @@ func (meta MetaQuery) ScopeName() string {
 }
 
 func (meta *MetaQuery) ListResource(ctx context.Context) (ImportList, error) {
-	log.Printf("[DEBUG] Query resource set")
+	log.Debug("Query resource set")
 	rset, err := meta.queryResourceSet(ctx, meta.argPredicate, meta.recursiveQuery)
 	if err != nil {
 		return nil, err
 	}
 	var rl []resourceset.TFResource
 	if meta.useAzAPI() {
-		log.Printf("[DEBUG] Azure Resource set map to TF resource set")
+		log.Debug("Azure Resource set map to TF resource set")
 		rl = rset.ToTFAzAPIResources()
 	} else {
-		log.Printf("[DEBUG] Populate resource set")
+		log.Debug("Populate resource set")
 		if err := rset.PopulateResource(); err != nil {
 			return nil, fmt.Errorf("tweaking single resources in the azure resource set: %v", err)
 		}
-		log.Printf("[DEBUG] Reduce resource set")
+		log.Debug("Reduce resource set")
 		if err := rset.ReduceResource(); err != nil {
 			return nil, fmt.Errorf("tweaking across resources in the azure resource set: %v", err)
 		}
 
-		log.Printf("[DEBUG] Azure Resource set map to TF resource set")
+		log.Debug("Azure Resource set map to TF resource set")
 		rl = rset.ToTFAzureRMResources(meta.parallelism, meta.azureSDKCred, meta.azureSDKClientOpt)
 	}
 

internal/meta/meta_query.go

@@ -20,7 +20,7 @@ type MetaResource struct {
 }
 
 func NewMetaResource(cfg config.Config) (*MetaResource, error) {
-	log.Printf("[INFO] New resource meta")
+	log.Info("New resource meta")
 	baseMeta, err := NewBaseMeta(cfg.CommonConfig)
 	if err != nil {
 		return nil, err
@@ -51,7 +51,7 @@ func (meta *MetaResource) ListResource(_ context.Context) (ImportList, error) {
 			},
 		},
 	}
-	log.Printf("[DEBUG] Azure Resource set map to TF resource set")
+	log.Debug("Azure Resource set map to TF resource set")
 
 	var rl []resourceset.TFResource
 	if meta.useAzAPI() {

internal/meta/meta_res.go

@@ -21,7 +21,7 @@ type MetaResourceGroup struct {
 }
 
 func NewMetaResourceGroup(cfg config.Config) (*MetaResourceGroup, error) {
-	log.Printf("[INFO] New resource group meta")
+	log.Info("New resource group meta")
 	baseMeta, err := NewBaseMeta(cfg.CommonConfig)
 	if err != nil {
 		return nil, err
@@ -42,7 +42,7 @@ func (meta MetaResourceGroup) ScopeName() string {
 }
 
 func (meta *MetaResourceGroup) ListResource(ctx context.Context) (ImportList, error) {
-	log.Printf("[DEBUG] Query resource set")
+	log.Debug("Query resource set")
 	rset, err := meta.queryResourceSet(ctx, meta.resourceGroup)
 	if err != nil {
 		return nil, err
@@ -52,17 +52,16 @@ func (meta *MetaResourceGroup) ListResource(ctx context.Context) (ImportList, er
 	if meta.useAzAPI() {
 		rl = rset.ToTFAzAPIResources()
 	} else {
-
-		log.Printf("[DEBUG] Populate resource set")
+		log.Debug("Populate resource set")
 		if err := rset.PopulateResource(); err != nil {
 			return nil, fmt.Errorf("tweaking single resources in the azure resource set: %v", err)
 		}
-		log.Printf("[DEBUG] Reduce resource set")
+		log.Debug("Reduce resource set")
 		if err := rset.ReduceResource(); err != nil {
 			return nil, fmt.Errorf("tweaking across resources in the azure resource set: %v", err)
 		}
 
-		log.Printf("[DEBUG] Azure Resource set map to TF resource set")
+		log.Debug("Azure Resource set map to TF resource set")
 		rl = rset.ToTFAzureRMResources(meta.parallelism, meta.azureSDKCred, meta.azureSDKClientOpt)
 	}
 

internal/meta/meta_rg.go

@@ -42,7 +42,7 @@ func (rset AzureResourceSet) ToTFAzureRMResources(parallelism int, cred azcore.T
 	wp.Run(func(v interface{}) error {
 		res := v.(result)
 		if res.err != nil {
-			log.Printf("[WARN] Failed to query resource type for %s: %v\n", res.resid, res.err)
+			log.Warn("Failed to query resource type", "id", res.resid, "error", res.err)
 			// Still put this unresolved resource in the resource set, so that users can later specify the expected TF resource type.
 			tfresources = append(tfresources, TFResource{
 				AzureId: res.resid,
@@ -52,7 +52,7 @@ func (rset AzureResourceSet) ToTFAzureRMResources(parallelism int, cred azcore.T
 		} else {
 			if !res.exact {
 				// It is not possible to return multiple result when API is used.
-				log.Printf("[WARN] No query result for resource type and TF id for %s\n", res.resid)
+				log.Warn("No query result for resource type and TF id", "id", res.resid)
 				// Still put this unresolved resource in the resource set, so that users can later specify the expected TF resource type.
 				tfresources = append(tfresources, TFResource{
 					AzureId: res.resid,

internal/resourceset/azure_resource_set.go

@@ -118,7 +118,7 @@ func (m model) Init() tea.Cmd {
 
 func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	if _, ok := msg.(spinner.TickMsg); !ok {
-		log.Printf("[DEBUG] UI update. STATUS: %s | MSG: %#v\n", m.status, msg)
+		log.Trace("UI update", "status", m.status, "msg", fmt.Sprintf("%#v", msg))
 	}
 
 	switch msg := msg.(type) {