Add --chdir option (#1612)

* Add --chdir option

* Make the values file path relative to the changed directory

* Load config file in the changed directory

README.md

@@ -139,13 +139,13 @@ Application Options:
       --var-file=FILE                                           Terraform variable file name
       --var='foo=bar'                                           Set a Terraform variable
       --module                                                  Inspect modules
+      --chdir=DIR                                               Switch to a different working directory before running inspection
       --force                                                   Return zero exit status even if issues found
       --color                                                   Enable colorized output
       --no-color                                                Disable colorized output
 
 Help Options:
   -h, --help                                                    Show this help message
-
 ```
 
 See [User Guide](docs/user-guide) for details.

cmd/cli.go

@@ -91,7 +91,7 @@ func (cli *CLI) Run(args []string) int {
 	case opts.Init:
 		return cli.init(opts)
 	case opts.Langserver:
-		return cli.startLanguageServer(opts.Config, opts.toConfig())
+		return cli.startLanguageServer(opts)
 	case opts.ActAsBundledPlugin:
 		return cli.actAsBundledPlugin()
 	default:

cmd/init.go

@@ -11,6 +11,11 @@ import (
 )
 
 func (cli *CLI) init(opts Options) int {
+	if opts.Chdir != "" {
+		fmt.Fprintf(cli.errStream, "Cannot use --chdir with --init\n")
+		return ExitCodeError
+	}
+
 	cfg, err := tflint.LoadConfig(afero.Afero{Fs: afero.NewOsFs()}, opts.Config)
 	if err != nil {
 		cli.formatter.Print(tflint.Issues{}, fmt.Errorf("Failed to load TFLint config; %w", err), map[string][]byte{})

cmd/inspect.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"os"
 	"strings"
 
 	"github.com/hashicorp/hcl/v2"
@@ -15,6 +16,25 @@ import (
 )
 
 func (cli *CLI) inspect(opts Options, dir string, filterFiles []string) int {
+	// Switch to a different working directory
+	originalWd, err := os.Getwd()
+	if err != nil {
+		cli.formatter.Print(tflint.Issues{}, fmt.Errorf("Failed to determine current working directory; %w", err), map[string][]byte{})
+		return ExitCodeError
+	}
+	if opts.Chdir != "" {
+		if dir != "." {
+			cli.formatter.Print(tflint.Issues{}, fmt.Errorf("Cannot use --chdir and directory argument at the same time"), map[string][]byte{})
+			return ExitCodeError
+		}
+
+		err := os.Chdir(opts.Chdir)
+		if err != nil {
+			cli.formatter.Print(tflint.Issues{}, fmt.Errorf("Failed to switch to a different working directory; %w", err), map[string][]byte{})
+			return ExitCodeError
+		}
+	}
+
 	// Setup config
 	cfg, err := tflint.LoadConfig(afero.Afero{Fs: afero.NewOsFs()}, opts.Config)
 	if err != nil {
@@ -32,14 +52,14 @@ func (cli *CLI) inspect(opts Options, dir string, filterFiles []string) int {
 	cli.formatter.Format = cfg.Format
 
 	// Setup loader
-	cli.loader, err = terraform.NewLoader(afero.Afero{Fs: afero.NewOsFs()})
+	cli.loader, err = terraform.NewLoader(afero.Afero{Fs: afero.NewOsFs()}, originalWd)
 	if err != nil {
 		cli.formatter.Print(tflint.Issues{}, fmt.Errorf("Failed to prepare loading; %w", err), map[string][]byte{})
 		return ExitCodeError
 	}
 
 	// Setup runners
-	runners, appErr := cli.setupRunners(opts, cfg, dir)
+	runners, appErr := cli.setupRunners(opts, cfg, originalWd, dir)
 	if appErr != nil {
 		cli.formatter.Print(tflint.Issues{}, appErr, cli.loader.Sources())
 		return ExitCodeError
@@ -129,7 +149,7 @@ func (cli *CLI) inspect(opts Options, dir string, filterFiles []string) int {
 	return ExitCodeOK
 }
 
-func (cli *CLI) setupRunners(opts Options, cfg *tflint.Config, dir string) ([]*tflint.Runner, error) {
+func (cli *CLI) setupRunners(opts Options, cfg *tflint.Config, originalWd string, dir string) ([]*tflint.Runner, error) {
 	configs, diags := cli.loader.LoadConfig(dir, cfg.Module)
 	if diags.HasErrors() {
 		return []*tflint.Runner{}, fmt.Errorf("Failed to load configurations; %w", diags)
@@ -162,7 +182,7 @@ func (cli *CLI) setupRunners(opts Options, cfg *tflint.Config, dir string) ([]*t
 	}
 	variables = append(variables, cliVars)
 
-	runner, err := tflint.NewRunner(cfg, annotations, configs, variables...)
+	runner, err := tflint.NewRunner(originalWd, cfg, annotations, configs, variables...)
 	if err != nil {
 		return []*tflint.Runner{}, fmt.Errorf("Failed to initialize a runner; %w", err)
 	}

cmd/langserver.go

@@ -2,15 +2,22 @@ package cmd
 
 import (
 	"context"
+	"fmt"
 	"log"
 	"os"
 
 	"github.com/sourcegraph/jsonrpc2"
 	"github.com/terraform-linters/tflint/langserver"
-	"github.com/terraform-linters/tflint/tflint"
 )
 
-func (cli *CLI) startLanguageServer(configPath string, cliConfig *tflint.Config) int {
+func (cli *CLI) startLanguageServer(opts Options) int {
+	if opts.Chdir != "" {
+		fmt.Fprintf(cli.errStream, "Cannot use --chdir with --langserver\n")
+		return ExitCodeError
+	}
+	configPath := opts.Config
+	cliConfig := opts.toConfig()
+
 	log.Println("Starting language server...")
 
 	handler, plugin, err := langserver.NewHandler(configPath, cliConfig)

cmd/option.go

@@ -22,6 +22,7 @@ type Options struct {
 	Varfiles           []string `long:"var-file" description:"Terraform variable file name" value-name:"FILE"`
 	Variables          []string `long:"var" description:"Set a Terraform variable" value-name:"'foo=bar'"`
 	Module             bool     `long:"module" description:"Inspect modules"`
+	Chdir              string   `long:"chdir" description:"Switch to a different working directory before running inspection" value-name:"DIR"`
 	Force              bool     `long:"force" description:"Return zero exit status even if issues found"`
 	Color              bool     `long:"color" description:"Enable colorized output"`
 	NoColor            bool     `long:"no-color" description:"Disable colorized output"`

cmd/version.go

@@ -10,6 +10,11 @@ import (
 )
 
 func (cli *CLI) printVersion(opts Options) int {
+	if opts.Chdir != "" {
+		fmt.Fprintf(cli.errStream, "Cannot use --chdir with --version\n")
+		return ExitCodeError
+	}
+
 	fmt.Fprintf(cli.outStream, "TFLint version %s\n", tflint.Version)
 
 	// Load configuration files to print plugin versions

integrationtest/cli/cli_test.go

@@ -274,6 +274,20 @@ func TestIntegration(t *testing.T) {
 			status:  cmd.ExitCodeError,
 			stderr:  fmt.Sprintf("Failed to load `%s`: Multiple files in different directories are not allowed", filepath.Join("subdir", "main.tf")),
 		},
+		{
+			name:    "--chdir",
+			command: "./tflint --chdir subdir",
+			dir:     "multiple_files",
+			status:  cmd.ExitCodeIssuesFound,
+			stdout:  fmt.Sprintf("%s (aws_instance_example_type)", color.New(color.Bold).Sprint("instance type is m5.2xlarge")),
+		},
+		{
+			name:    "--chdir and directory argument",
+			command: "./tflint --chdir subdir ../",
+			dir:     "multiple_files",
+			status:  cmd.ExitCodeError,
+			stderr:  "Cannot use --chdir and directory argument at the same time",
+		},
 	}
 
 	dir, _ := os.Getwd()

integrationtest/cli/multiple_files/subdir/.tflint.hcl

@@ -0,0 +1,3 @@
+plugin "testing" {
+  enabled = true
+}

integrationtest/inspection/bad-config/.tflint.hcl

@@ -1,7 +1,3 @@
 plugin "testing" {
   enabled = true
 }
-
-plugin "aws" {
-  enabled = false
-}

integrationtest/inspection/chdir/dir/.terraform/modules/modules.json

@@ -0,0 +1 @@
+{"Modules":[{"Key":"","Source":"","Dir":"."},{"Key":"aws_instance","Source":"./module","Dir":"module"}]}

integrationtest/inspection/chdir/dir/.tflint.hcl

@@ -0,0 +1,11 @@
+plugin "testing" {
+  enabled = true
+}
+
+plugin "terraform" {
+  enabled = false
+}
+
+config {
+  varfile = ["from_config.tfvars"]
+}

integrationtest/inspection/chdir/dir/dir.txt

@@ -0,0 +1 @@
+file_in_dir

integrationtest/inspection/chdir/dir/from_cli.tfvars

@@ -0,0 +1 @@
+from_cli="from_cli"

integrationtest/inspection/chdir/dir/from_config.tfvars

@@ -0,0 +1 @@
+from_config="from_config"

integrationtest/inspection/chdir/dir/main.tf

@@ -0,0 +1,21 @@
+variable "from_config" {
+  default = "default"
+}
+
+variable "from_cli" {
+  default = "default"
+}
+
+variable "from_auto" {
+  default = "default"
+}
+
+variable "from_auto_default" {
+  default = "default"
+}
+
+module "aws_instance" {
+  source = "./module"
+
+  instance_type = "${var.from_config}-${var.from_cli}-${var.from_auto}-${var.from_auto_default}-${file("dir.txt")}-${file("${path.cwd}/root.txt")}"
+}

integrationtest/inspection/chdir/dir/module/main.tf

@@ -0,0 +1,5 @@
+variable "instance_type" {}
+
+resource "aws_instance" "main" {
+  instance_type = var.instance_type
+}

integrationtest/inspection/chdir/dir/subdir.auto.tfvars

@@ -0,0 +1 @@
+from_auto="from_auto"

integrationtest/inspection/chdir/dir/terraform.tfvars

@@ -0,0 +1 @@
+from_auto_default="from_auto_default"

integrationtest/inspection/chdir/result.json

@@ -0,0 +1,48 @@
+{
+  "issues": [
+    {
+      "rule": {
+        "name": "aws_instance_example_type",
+        "severity": "error",
+        "link": ""
+      },
+      "message": "instance type is from_config-from_cli-from_auto-from_auto_default-file_in_dir-file_in_root",
+      "range": {
+        "filename": "dir/main.tf",
+        "start": {
+          "line": 20,
+          "column": 19
+        },
+        "end": {
+          "line": 20,
+          "column": 148
+        }
+      },
+      "callers": [
+        {
+          "filename": "dir/main.tf",
+          "start": {
+            "line": 20,
+            "column": 19
+          },
+          "end": {
+            "line": 20,
+            "column": 148
+          }
+        },
+        {
+          "filename": "dir/module/main.tf",
+          "start": {
+            "line": 4,
+            "column": 19
+          },
+          "end": {
+            "line": 4,
+            "column": 36
+          }
+        }
+      ]
+    }
+  ],
+  "errors": []
+}

integrationtest/inspection/chdir/result_windows.json

@@ -0,0 +1,48 @@
+{
+  "issues": [
+    {
+      "rule": {
+        "name": "aws_instance_example_type",
+        "severity": "error",
+        "link": ""
+      },
+      "message": "instance type is from_config-from_cli-from_auto-from_auto_default-file_in_dir-file_in_root",
+      "range": {
+        "filename": "dir\\main.tf",
+        "start": {
+          "line": 20,
+          "column": 19
+        },
+        "end": {
+          "line": 20,
+          "column": 148
+        }
+      },
+      "callers": [
+        {
+          "filename": "dir\\main.tf",
+          "start": {
+            "line": 20,
+            "column": 19
+          },
+          "end": {
+            "line": 20,
+            "column": 148
+          }
+        },
+        {
+          "filename": "dir\\module\\main.tf",
+          "start": {
+            "line": 4,
+            "column": 19
+          },
+          "end": {
+            "line": 4,
+            "column": 36
+          }
+        }
+      ]
+    }
+  ],
+  "errors": []
+}

integrationtest/inspection/chdir/root.txt

@@ -0,0 +1 @@
+file_in_root

integrationtest/inspection/inspection_test.go

@@ -203,6 +203,11 @@ func TestIntegration(t *testing.T) {
 			Command: "tflint --module --format json",
 			Dir:     "expand",
 		},
+		{
+			Name:    "chdir",
+			Command: "tflint --chdir dir --module --var-file from_cli.tfvars --format json",
+			Dir:     "chdir",
+		},
 	}
 
 	// Disable the bundled plugin because the `os.Executable()` is go(1) in the tests
@@ -225,6 +230,11 @@ func TestIntegration(t *testing.T) {
 				t.Fatal(err)
 			}
 
+			resultFile := "result.json"
+			if runtime.GOOS == "windows" && IsWindowsResultExist() {
+				resultFile = "result_windows.json"
+			}
+
 			if tc.Env != nil {
 				for k, v := range tc.Env {
 					t.Setenv(k, v)
@@ -237,13 +247,7 @@ func TestIntegration(t *testing.T) {
 
 			cli.Run(args)
 
-			var b []byte
-			var err error
-			if runtime.GOOS == "windows" && IsWindowsResultExist() {
-				b, err = os.ReadFile(filepath.Join(testDir, "result_windows.json"))
-			} else {
-				b, err = os.ReadFile(filepath.Join(testDir, "result.json"))
-			}
+			b, err := os.ReadFile(filepath.Join(testDir, resultFile))
 			if err != nil {
 				t.Fatal(err)
 			}

langserver/handler.go

@@ -144,7 +144,7 @@ func (h *handler) chdir(dir string) error {
 func (h *handler) inspect() (map[string][]lsp.Diagnostic, error) {
 	ret := map[string][]lsp.Diagnostic{}
 
-	loader, err := terraform.NewLoader(afero.Afero{Fs: h.fs})
+	loader, err := terraform.NewLoader(afero.Afero{Fs: h.fs}, h.rootDir)
 	if err != nil {
 		return ret, fmt.Errorf("Failed to prepare loading: %w", err)
 	}
@@ -177,7 +177,7 @@ func (h *handler) inspect() (map[string][]lsp.Diagnostic, error) {
 	}
 	variables = append(variables, cliVars)
 
-	runner, err := tflint.NewRunner(h.config, annotations, configs, variables...)
+	runner, err := tflint.NewRunner(h.rootDir, h.config, annotations, configs, variables...)
 	if err != nil {
 		return ret, fmt.Errorf("Failed to initialize a runner: %w", err)
 	}