Merge pull request #24 from gruntwork-io/yori-check-skipenv

Check skipenv

Author: yorinasub17

.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2.1
+
+jobs:
+  unit_test:
+    machine:
+      enabled: true
+      image: "ubuntu-1604:201903-01"
+    steps:
+      - checkout
+      - run:
+          name: run py tests
+          command: |
+            cd test
+            pip install --upgrade pip
+            pip install tox
+            tox
+
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - unit_test:
+          filters:
+            tags:
+              only: /^v.*/

.gitignore

@@ -11,3 +11,9 @@
 build/
 */build/
 out/
+
+# Python
+.mypy_cache
+*.pyc
+__pycache__
+.tox

.pre-commit-hooks.yaml

@@ -94,3 +94,10 @@
   language: script
   files: \.md$
   exclude: vendor\/.*$
+
+- id: check-terratest-skip-env
+  name: check-terratest-skip-env
+  description: Check all go source files for any uncommented os.Setenv calls setting a terratest SKIP environment.
+  entry: ./hooks/check_skip_env.py
+  language: script
+  files: \.go$

hooks/check_skip_env.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+import re
+import sys
+import argparse
+import logging
+
+
+logging.basicConfig(format='%(asctime)s [%(levelname)s] %(message)s', level=logging.INFO)
+
+
+def has_setenv_skip(fpath):
+    with open(fpath) as f:
+        for line in f:
+            if re.match(r'^\s+os.Setenv\(\"(SKIP_|TERRATEST_REGION)', line):
+                return True
+    return False
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description=(
+            'A CLI for checking to make sure no uncommented os.Setenv calls are '
+            'committed in test golang files. Each positional argument should be a golang source file.'
+        ),
+    )
+    parser.add_argument(
+        'files',
+        metavar='FILE',
+        type=str,
+        nargs='+',
+        help='The file to check.',
+    )
+    args = parser.parse_args()
+    return args
+
+
+def main():
+    args = parse_args()
+    files_with_setenv_skip = [fpath for fpath in args.files if has_setenv_skip(fpath)]
+    if files_with_setenv_skip:
+        logging.error('Found files with os.Setenv calls setting terratest SKIP environment variables.')
+        for f in files_with_setenv_skip:
+            logging.error('- {}'.format(f))
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

test/.python-version

@@ -0,0 +1 @@
+2.7.12:3.5.2

test/check_skip_env_test.py

@@ -0,0 +1,70 @@
+import os
+import sys
+import glob
+import unittest
+
+if sys.version_info[0] < 3:
+    import subprocess32 as subprocess
+else:
+    import subprocess
+
+
+class TestCheckSkipEnv(unittest.TestCase):
+    def setUp(self):
+        self.root = get_git_root()
+        self.hook_script = os.path.join(self.root, 'hooks', 'check_skip_env.py')
+        self.fixture_dir = os.path.join(self.root, 'test', 'fixtures')
+
+    def _check_success(self, files):
+        subprocess.run([self.hook_script] + files, check=True)
+
+    def _check_failure(self, files, failed_files):
+        result = subprocess.run([self.hook_script] + files, stderr=subprocess.PIPE)
+        self.assertEqual(result.returncode, 1)
+        for f in failed_files:
+            self.assertIn(f, result.stderr.decode('utf-8'))
+
+    def test_everything_commented(self):
+        self._check_success([os.path.join(self.fixture_dir, 'everything_commented_test.go')])
+
+    def test_non_skip_uncommented(self):
+        self._check_success([os.path.join(self.fixture_dir, 'non_skip_uncommented_test.go')])
+
+    def test_skip_uncommented(self):
+        test_file_path = os.path.join(self.fixture_dir, 'skip_uncommented_test.go')
+        self._check_failure([test_file_path], [test_file_path])
+
+    def test_terratest_region_uncommented(self):
+        test_file_path = os.path.join(self.fixture_dir, 'terratest_region_uncommented_test.go')
+        self._check_failure([test_file_path], [test_file_path])
+
+    def test_multiple_skip_uncommented(self):
+        test_file_path = os.path.join(self.fixture_dir, 'multiple_skip_uncommented_test.go')
+        self._check_failure([test_file_path], [test_file_path])
+
+    def test_nested_uncommented(self):
+        test_file_path = os.path.join(self.fixture_dir, 'nested_uncommented_test.go')
+        self._check_failure([test_file_path], [test_file_path])
+
+    def test_everything(self):
+        all_test_files = glob.glob(os.path.join(self.fixture_dir, '*.go'))
+        failed_files = [
+            os.path.join(self.fixture_dir, 'skip_uncommented_test.go'),
+            os.path.join(self.fixture_dir, 'multiple_skip_uncommented_test.go'),
+            os.path.join(self.fixture_dir, 'nested_uncommented_test.go'),
+            os.path.join(self.fixture_dir, 'terratest_region_uncommented_test.go'),
+        ]
+        self._check_failure(all_test_files, failed_files)
+
+
+def get_git_root():
+    """ Returns the root directory of the git repository, assuming this script is run from within the repository. """
+    result = subprocess.run(['git', 'rev-parse', '--show-toplevel'], stdout=subprocess.PIPE, check=True)
+    if result.stdout is None:
+        # TODO: concrete exception
+        raise Exception('Did not get any output from git: stderr is "{}"'.format(result.stderr))
+    return result.stdout.decode('utf-8').rstrip('\n')
+
+
+if __name__ == '__main__':
+    unittest.main()

test/fixtures/everything_commented_test.go

@@ -0,0 +1,35 @@
+package basecase
+
+import (
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/logger"
+	test_structure "github.com/gruntwork-io/terratest/modules/test-structure"
+)
+
+func TestWithStages(t *testing.T) {
+	t.Parallel()
+
+	// Uncomment the items below to skip certain parts of the test
+	//os.Setenv("TERRATEST_REGION", "eu-west-1")
+	//os.Setenv("SKIP_setup", "true")
+	//os.Setenv("SKIP_deploy", "true")
+	//os.Setenv("SKIP_validate", "true")
+	//os.Setenv("SKIP_cleanup", "true")
+
+	test_structure.RunTestStage(t, "setup", func() {
+		logger.Logf(t, "setup")
+	})
+
+	defer test_structure.RunTestStage(t, "cleanup", func() {
+		logger.Logf(t, "cleanup")
+	})
+
+	test_structure.RunTestStage(t, "deploy", func() {
+		logger.Logf(t, "deploy")
+	})
+
+	test_structure.RunTestStage(t, "validate", func() {
+		logger.Logf(t, "validate")
+	})
+}

test/fixtures/multiple_skip_uncommented_test.go

@@ -0,0 +1,36 @@
+package basecase
+
+import (
+	"os"
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/logger"
+	test_structure "github.com/gruntwork-io/terratest/modules/test-structure"
+)
+
+func TestWithStages(t *testing.T) {
+	t.Parallel()
+
+	// Uncomment the items below to skip certain parts of the test
+	//os.Setenv("TERRATEST_REGION", "eu-west-1")
+	//os.Setenv("SKIP_setup", "true")
+	os.Setenv("SKIP_deploy", "true")
+	os.Setenv("SKIP_validate", "true")
+	//os.Setenv("SKIP_cleanup", "true")
+
+	test_structure.RunTestStage(t, "setup", func() {
+		logger.Logf(t, "setup")
+	})
+
+	defer test_structure.RunTestStage(t, "cleanup", func() {
+		logger.Logf(t, "cleanup")
+	})
+
+	test_structure.RunTestStage(t, "deploy", func() {
+		logger.Logf(t, "deploy")
+	})
+
+	test_structure.RunTestStage(t, "validate", func() {
+		logger.Logf(t, "validate")
+	})
+}

test/fixtures/nested_uncommented_test.go

@@ -0,0 +1,40 @@
+package basecase
+
+import (
+	"os"
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/logger"
+	test_structure "github.com/gruntwork-io/terratest/modules/test-structure"
+)
+
+func TestWithStages(t *testing.T) {
+	t.Parallel()
+
+	// Uncomment the items below to skip certain parts of the test
+	//os.Setenv("TERRATEST_REGION", "eu-west-1")
+	//os.Setenv("SKIP_setup", "true")
+	//os.Setenv("SKIP_deploy", "true")
+	//os.Setenv("SKIP_cleanup", "true")
+
+	test_structure.RunTestStage(t, "setup", func() {
+		logger.Logf(t, "setup")
+	})
+
+	defer test_structure.RunTestStage(t, "cleanup", func() {
+		logger.Logf(t, "cleanup")
+	})
+
+	test_structure.RunTestStage(t, "deploy", func() {
+		logger.Logf(t, "deploy")
+	})
+
+	for _, data := range testCases {
+		t.Run(data.name, func(t *testing.T) {
+			os.Setenv("SKIP_validate")
+			test_structure.RunTestStage(t, "validate", func() {
+				logger.Logf(t, "validate")
+			})
+		})
+	}
+}

test/fixtures/non_skip_uncommented_test.go

@@ -0,0 +1,36 @@
+package basecase
+
+import (
+	"os"
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/logger"
+	test_structure "github.com/gruntwork-io/terratest/modules/test-structure"
+)
+
+func TestWithStages(t *testing.T) {
+	t.Parallel()
+
+	// Uncomment the items below to skip certain parts of the test
+	os.Setenv("THE_ANSWER", "42")
+	//os.Setenv("SKIP_setup", "true")
+	//os.Setenv("SKIP_deploy", "true")
+	//os.Setenv("SKIP_validate", "true")
+	//os.Setenv("SKIP_cleanup", "true")
+
+	test_structure.RunTestStage(t, "setup", func() {
+		logger.Logf(t, "setup")
+	})
+
+	defer test_structure.RunTestStage(t, "cleanup", func() {
+		logger.Logf(t, "cleanup")
+	})
+
+	test_structure.RunTestStage(t, "deploy", func() {
+		logger.Logf(t, "deploy")
+	})
+
+	test_structure.RunTestStage(t, "validate", func() {
+		logger.Logf(t, "validate")
+	})
+}