Accept a directory as an argument

README.md

@@ -87,7 +87,7 @@ TFLint inspects all configurations under the current directory by default. You c
 ```
 $ tflint --help
 Usage:
-  tflint [OPTIONS]
+  tflint [OPTIONS] [FILE or DIR...]
 
 Application Options:
   -v, --version                             Print TFLint version

cmd/cli.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"path/filepath"
+	"strings"
 
 	"github.com/fatih/color"
 	flags "github.com/jessevdk/go-flags"
@@ -44,7 +46,7 @@ func NewCLI(outStream io.Writer, errStream io.Writer) *CLI {
 func (cli *CLI) Run(args []string) int {
 	var opts Options
 	parser := flags.NewParser(&opts, flags.HelpFlag)
-	parser.Usage = "[OPTIONS]"
+	parser.Usage = "[OPTIONS] [FILE or DIR...]"
 	parser.UnknownOptionHandler = func(option string, arg flags.SplitArgument, args []string) ([]string, error) {
 		if option == "debug" {
 			return []string{}, errors.New("`debug` option was removed in v0.8.0. Please set `TFLINT_LOG` environment variables instead")
@@ -61,7 +63,11 @@ func (cli *CLI) Run(args []string) int {
 		cli.printError(err)
 		return ExitCodeError
 	}
-	argFiles := args[1:]
+	dir, filterFiles, err := processArgs(args[1:])
+	if err != nil {
+		cli.printError(err)
+		return ExitCodeError
+	}
 
 	// Show version
 	if opts.Version {
@@ -85,26 +91,13 @@ func (cli *CLI) Run(args []string) int {
 			return ExitCodeError
 		}
 	}
-	for _, file := range argFiles {
-		if fileInfo, err := os.Stat(file); os.IsNotExist(err) {
-			cli.printError(fmt.Errorf("Failed to load `%s`: File not found", file))
-			return ExitCodeError
-		} else if fileInfo.IsDir() {
-			cli.printError(fmt.Errorf("Failed to load `%s`: TFLint doesn't accept directories as arguments", file))
-			return ExitCodeError
-		}
 
-		if !cli.loader.IsConfigFile(file) {
-			cli.printError(fmt.Errorf("Failed to load `%s`: File is not a target of Terraform", file))
-			return ExitCodeError
-		}
-	}
-	configs, err := cli.loader.LoadConfig()
+	configs, err := cli.loader.LoadConfig(dir)
 	if err != nil {
 		cli.printError(fmt.Errorf("Failed to load configurations: %s", err))
 		return ExitCodeError
 	}
-	annotations, err := cli.loader.LoadAnnotations()
+	annotations, err := cli.loader.LoadAnnotations(dir)
 	if err != nil {
 		cli.printError(fmt.Errorf("Failed to load configuration tokens: %s", err))
 		return ExitCodeError
@@ -136,7 +129,7 @@ func (cli *CLI) Run(args []string) int {
 
 	issues := []*issue.Issue{}
 	for _, runner := range runners {
-		issues = append(issues, runner.LookupIssues(argFiles...)...)
+		issues = append(issues, runner.LookupIssues(filterFiles...)...)
 	}
 
 	// Print issues
@@ -152,3 +145,46 @@ func (cli *CLI) Run(args []string) int {
 func (cli *CLI) printError(err error) {
 	fmt.Fprintln(cli.errStream, color.New(color.FgRed).Sprintf("Error: ")+err.Error())
 }
+
+func processArgs(args []string) (string, []string, error) {
+	if len(args) == 0 {
+		return ".", []string{}, nil
+	}
+
+	var dir string
+	filterFiles := []string{}
+
+	for _, file := range args {
+		fileInfo, err := os.Stat(file)
+		if err != nil {
+			if os.IsNotExist(err) {
+				return dir, filterFiles, fmt.Errorf("Failed to load `%s`: File not found", file)
+			}
+			return dir, filterFiles, fmt.Errorf("Failed to load `%s`: %s", file, err)
+		}
+
+		if fileInfo.IsDir() {
+			dir = file
+			if len(args) != 1 {
+				return dir, filterFiles, fmt.Errorf("Failed to load `%s`: Multiple arguments are not allowed when passing a directory", file)
+			}
+			return dir, filterFiles, nil
+		}
+
+		if !strings.HasSuffix(file, ".tf") && !strings.HasSuffix(file, ".tf.json") {
+			return dir, filterFiles, fmt.Errorf("Failed to load `%s`: File is not a target of Terraform", file)
+		}
+
+		fileDir := filepath.Dir(file)
+		if dir == "" {
+			dir = fileDir
+			filterFiles = append(filterFiles, file)
+		} else if fileDir == dir {
+			filterFiles = append(filterFiles, file)
+		} else {
+			return dir, filterFiles, fmt.Errorf("Failed to load `%s`: Multiple files in different directories are not allowed", file)
+		}
+	}
+
+	return dir, filterFiles, nil
+}

cmd/cli_test.go

@@ -103,8 +103,8 @@ func TestCLIRun__noIssuesFound(t *testing.T) {
 		}
 
 		loader := tflint.NewMockAbstractLoader(ctrl)
-		loader.EXPECT().LoadConfig().Return(configs.NewEmptyConfig(), tc.LoadErr).AnyTimes()
-		loader.EXPECT().LoadAnnotations().Return(map[string]tflint.Annotations{}, tc.LoadErr).AnyTimes()
+		loader.EXPECT().LoadConfig(".").Return(configs.NewEmptyConfig(), tc.LoadErr).AnyTimes()
+		loader.EXPECT().LoadAnnotations(".").Return(map[string]tflint.Annotations{}, tc.LoadErr).AnyTimes()
 		loader.EXPECT().LoadValuesFiles().Return([]terraform.InputValues{}, tc.LoadErr).AnyTimes()
 		cli.loader = loader
 
@@ -122,7 +122,9 @@ func TestCLIRun__noIssuesFound(t *testing.T) {
 	}
 }
 
-type testRule struct{}
+type testRule struct {
+	dir string
+}
 type errorRule struct{}
 
 func (r *testRule) Name() string {
@@ -154,11 +156,16 @@ func (r *errorRule) Link() string {
 }
 
 func (r *testRule) Check(runner *tflint.Runner) error {
+	filename := "test.tf"
+	if r.dir != "" {
+		filename = filepath.Join(r.dir, filename)
+	}
+
 	runner.EmitIssue(
 		r,
 		"This is test error",
 		hcl.Range{
-			Filename: "test.tf",
+			Filename: filename,
 			Start:    hcl.Pos{Line: 1},
 		},
 	)
@@ -226,8 +233,8 @@ func TestCLIRun__issuesFound(t *testing.T) {
 		}
 
 		loader := tflint.NewMockAbstractLoader(ctrl)
-		loader.EXPECT().LoadConfig().Return(configs.NewEmptyConfig(), nil).AnyTimes()
-		loader.EXPECT().LoadAnnotations().Return(map[string]tflint.Annotations{}, nil).AnyTimes()
+		loader.EXPECT().LoadConfig(".").Return(configs.NewEmptyConfig(), nil).AnyTimes()
+		loader.EXPECT().LoadAnnotations(".").Return(map[string]tflint.Annotations{}, nil).AnyTimes()
 		loader.EXPECT().LoadValuesFiles().Return([]terraform.InputValues{}, nil).AnyTimes()
 		cli.loader = loader
 
@@ -247,46 +254,82 @@ func TestCLIRun__issuesFound(t *testing.T) {
 
 func TestCLIRun__withArguments(t *testing.T) {
 	cases := []struct {
-		Name         string
-		Command      string
-		IsConfigFile bool
-		Status       int
-		Stdout       string
-		Stderr       string
+		Name    string
+		Command string
+		Dir     string
+		Status  int
+		Stdout  string
+		Stderr  string
 	}{
 		{
 			Name:    "no arguments",
 			Command: "./tflint",
+			Dir:     ".",
 			Status:  ExitCodeOK,
 			Stdout:  "This is test error (test_rule)",
 		},
 		{
-			Name:         "files arguments",
-			Command:      "./tflint template.tf",
-			IsConfigFile: true,
-			Status:       ExitCodeOK,
-			Stdout:       "Awesome! Your code is following the best practices :)",
+			Name:    "files arguments",
+			Command: "./tflint template.tf",
+			Dir:     ".",
+			Status:  ExitCodeOK,
+			Stdout:  "Awesome! Your code is following the best practices :)",
+		},
+		{
+			Name:    "file not found",
+			Command: "./tflint not_found.tf",
+			Dir:     ".",
+			Status:  ExitCodeError,
+			Stderr:  "Failed to load `not_found.tf`: File not found",
 		},
 		{
-			Name:         "directories arguments",
-			Command:      "./tflint ./",
-			IsConfigFile: true,
-			Status:       ExitCodeError,
-			Stderr:       "Failed to load `./`: TFLint doesn't accept directories as arguments",
+			Name:    "not Terraform configuration",
+			Command: "./tflint README",
+			Dir:     ".",
+			Status:  ExitCodeError,
+			Stderr:  "Failed to load `README`: File is not a target of Terraform",
 		},
 		{
-			Name:         "file not found",
-			Command:      "./tflint not_found.tf",
-			IsConfigFile: true,
-			Status:       ExitCodeError,
-			Stderr:       "Failed to load `not_found.tf`: File not found",
+			Name:    "multiple files",
+			Command: "./tflint template.tf test.tf",
+			Dir:     ".",
+			Status:  ExitCodeOK,
+			Stdout:  "This is test error (test_rule)",
 		},
 		{
-			Name:         "not Terraform configuration",
-			Command:      "./tflint README",
-			IsConfigFile: false,
-			Status:       ExitCodeError,
-			Stderr:       "Failed to load `README`: File is not a target of Terraform",
+			Name:    "directory argument",
+			Command: "./tflint example",
+			Dir:     "example",
+			Status:  ExitCodeOK,
+			Stdout:  "This is test error (test_rule)",
+		},
+		{
+			Name:    "file under the directory",
+			Command: fmt.Sprintf("./tflint %s", filepath.Join("example", "test.tf")),
+			Dir:     "example",
+			Status:  ExitCodeOK,
+			Stdout:  "This is test error (test_rule)",
+		},
+		{
+			Name:    "multiple directories",
+			Command: "./tflint example ./",
+			Dir:     "example",
+			Status:  ExitCodeError,
+			Stderr:  "Failed to load `example`: Multiple arguments are not allowed when passing a directory",
+		},
+		{
+			Name:    "file and directory",
+			Command: "./tflint template.tf example",
+			Dir:     "example",
+			Status:  ExitCodeError,
+			Stderr:  "Failed to load `example`: Multiple arguments are not allowed when passing a directory",
+		},
+		{
+			Name:    "multiple files in different directories",
+			Command: fmt.Sprintf("./tflint test.tf %s", filepath.Join("example", "test.tf")),
+			Dir:     "example",
+			Status:  ExitCodeError,
+			Stderr:  fmt.Sprintf("Failed to load `%s`: Multiple files in different directories are not allowed", filepath.Join("example", "test.tf")),
 		},
 	}
 
@@ -310,7 +353,7 @@ func TestCLIRun__withArguments(t *testing.T) {
 
 	for _, tc := range cases {
 		// Mock rules
-		rules.DefaultRules = []rules.Rule{&testRule{}}
+		rules.DefaultRules = []rules.Rule{&testRule{dir: tc.Dir}}
 
 		outStream, errStream := new(bytes.Buffer), new(bytes.Buffer)
 		cli := &CLI{
@@ -320,9 +363,8 @@ func TestCLIRun__withArguments(t *testing.T) {
 		}
 
 		loader := tflint.NewMockAbstractLoader(ctrl)
-		loader.EXPECT().IsConfigFile(gomock.Any()).Return(tc.IsConfigFile).AnyTimes()
-		loader.EXPECT().LoadConfig().Return(configs.NewEmptyConfig(), nil).AnyTimes()
-		loader.EXPECT().LoadAnnotations().Return(map[string]tflint.Annotations{}, nil).AnyTimes()
+		loader.EXPECT().LoadConfig(tc.Dir).Return(configs.NewEmptyConfig(), nil).AnyTimes()
+		loader.EXPECT().LoadAnnotations(tc.Dir).Return(map[string]tflint.Annotations{}, nil).AnyTimes()
 		loader.EXPECT().LoadValuesFiles().Return([]terraform.InputValues{}, nil).AnyTimes()
 		cli.loader = loader
 

cmd/test-fixtures/arguments/example/test.tf

@@ -0,0 +1,8 @@
+resource "aws_instance" "backend" {
+  ami           = "ami-b73b63a0"
+  instance_type = "t1.2xlarge"
+
+  tags {
+    Name = "HelloWorld"
+  }
+}

integration/arguments/dir/.terraform/modules/modules.json

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

integration/arguments/dir/example.tf

@@ -0,0 +1,3 @@
+resource "aws_instance" "example" {
+  instance_type = "t1.2xlarge"
+}

integration/arguments/dir/module/template.tf

@@ -0,0 +1,3 @@
+resource "aws_instance" "example" {
+  instance_type = "t1.2xlarge"
+}

integration/arguments/dir/template.tf

@@ -0,0 +1,8 @@
+resource "aws_instance" "template" {
+  instance_type = "t1.2xlarge"
+}
+
+// `terraform get` in Terraform v0.12
+module "instances" {
+  source = "./module"
+}

integration/arguments/result.json

@@ -0,0 +1,10 @@
+[
+  {
+    "detector": "aws_instance_invalid_type",
+    "type": "ERROR",
+    "message": "\"t1.2xlarge\" is invalid instance type.",
+    "line": 2,
+    "file": "dir/template.tf",
+    "link": ""
+  }
+]

integration/arguments/result_windows.json

@@ -0,0 +1,10 @@
+[
+  {
+    "detector": "aws_instance_invalid_type",
+    "type": "ERROR",
+    "message": "\"t1.2xlarge\" is invalid instance type.",
+    "line": 2,
+    "file": "dir\\template.tf",
+    "link": ""
+  }
+]

integration/arguments/template.tf

@@ -0,0 +1,3 @@
+resource "aws_instance" "default" {
+  instance_type = "t1.2xlarge"
+}