Merge branch 'master' into fix_issue-284-temp

Author: eerkunt

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 1.2.4 (2020-06-03)
+* Add ability to reference a git repo by branch name and directory via `<repo>.git//<directory>?ref=<branch-name`. ([#218](https://github.com/eerkunt/terraform-compliance/issues/218))
+
 ## 1.2.3 (2020-05-25)
 * Fixed a crash where some module outputs could not be processed. ([#275](https://github.com/eerkunt/terraform-compliance/issues/275))
 

docs/pages/usage/index.md

@@ -70,6 +70,18 @@ or if the repository is a private repository ;
 The authentication to that git repository will be handled via your `~/.ssh/config`. If you are using a different
 ssh key for this repository then you also need to provide `-i` parameter to pointing your private key.
 
+New in `1.2.4`, a repository can be referenced by branch name and directory. This uses syntax similar to Terraform
+[Modules in Package Sub-directories](https://www.terraform.io/docs/modules/sources.html#modules-in-package-sub-directories).
+The reference must include `//` after `.git` and end with `?ref=<branch-name>` or `?ref=<tag>`.
+```
+[~] $ terraform-compliance -f git:ssh://github.com/user/repo.git//directory?ref=v1.0.0 ...
+```
+The directory is optional.
+```
+[~] $ terraform-compliance -f git:ssh://github.com/user/repo.git//?ref=staging ...
+```
+
+
 ### -p / --planfile
 {: .d-inline-block }
 REQUIRED

requirements.txt

@@ -1,12 +1,12 @@
 radish-bdd==0.13.1
 mock==4.0.2
-gitpython==3.1.2
+gitpython==3.1.3
 netaddr==0.7.19
 colorful==0.5.4
 filetype==1.0.7
 junit-xml==1.9
 emoji==0.5.4
 lxml==4.5.1
 ddt==1.4.1
-pytest==5.4.2
+pytest==5.4.3
 nose==1.3.7

terraform_compliance/main.py

@@ -61,14 +61,34 @@ def cli(arghandling=ArgHandling(), argparser=ArgumentParser(prog=__app_name__,
     if args.ssh_key:
         ssh_cmd = {'GIT_SSH_COMMAND': 'ssh -l {} -i {}'.format('git', args.ssh_key)}
 
+    features_dir = '/'
     # A remote repository used here
     if args.features.startswith(('http', 'https', 'ssh')):
-        features_git_repo = args.features
+        # Default to master branch and full repository
+        if args.features.endswith('.git'):
+            features_git_repo = args.features
+            features_git_branch = 'master'
+
+        # Optionally allow for directory and branch
+        elif '.git//' in args.features and '?ref=' in args.features:
+            # Split on .git/
+            features_git_list = args.features.split('.git/', 1)
+            # Everything up to .git is the repository
+            features_git_repo = features_git_list[0] + '.git'
+
+            # Split the directory and branch ref
+            features_git_list = features_git_list[1].split('?ref=', 1)
+            features_dir = features_git_list[0]
+            features_git_branch = features_git_list[1]
+
+        else:  # invalid
+            raise ValueError("Bad feature directory:" + args.features)
+
+        # Clone repository
         args.features = mkdtemp()
+        Repo.clone_from(url=features_git_repo, to_path=args.features, env=ssh_cmd, depth=1, branch=features_git_branch)
 
-        Repo.clone_from(url=features_git_repo, to_path=args.features, env=ssh_cmd)
-
-    features_directory = os.path.join(os.path.abspath(args.features))
+    features_directory = os.path.join(os.path.abspath(args.features) + features_dir)
 
     commands = ['radish',
                 '--write-steps-once',