Merge pull request #34 from dflook/collapsable-plan

Make PR comment plans collapsable

Author: dflook

.github/workflows/test-plan.yaml

@@ -118,6 +118,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Change terraform 14
     env:
+      TF_PLAN_COLLAPSE_LENGTH: 30
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout

.github/workflows/test.yaml

@@ -18,8 +18,8 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest
+          pip install -r tests/requirements.txt
 
       - name: Run tests
         run: |
-          PYTHONPATH=image/tools pytest tests
+          GITHUB_TOKEN=No PYTHONPATH=image/tools pytest tests

.gitignore

@@ -1,4 +1,5 @@
 .terraform/
 /.idea/
 .pytest_cache/
-/venv/
+/venv/
+.terraform.lock.hcl

CHANGELOG.md

@@ -8,10 +8,21 @@ The actions are versioned as a suite. Some actions may have no change in behavio
 
 When using an action you can specify the version as:
 
-- `@v1.5.2` to use an exact release
-- `@v1.5` to use the latest patch release for the specific minor version
+- `@v1.6.0` to use an exact release
+- `@v1.6` to use the latest patch release for the specific minor version
 - `@v1` to use the latest patch release for the specific major version
 
+## [1.6.0] - 2021-02-25
+
+### Added
+- PR comments use a one line summary of the terraform output, with the full output in a collapsable pane.
+
+  If a plan is short the output is shown by default. This can be controlled with the `TF_PLAN_COLLAPSE_LENGTH` environment
+  variable for the [dflook/terraform-plan](terraform-plan) action.
+
+### Fixed
+- Now makes far fewer github api requests to avoid rate limiting.
+
 ## [1.5.2] - 2021-01-16
 
 ### Fixed
@@ -95,6 +106,7 @@ First release of the GitHub Actions:
 - [dflook/terraform-new-workspace](terraform-new-workspace)
 - [dflook/terraform-destroy-workspace](terraform-destroy-workspace)
 
+[1.6.0]: https://github.com/dflook/terraform-github-actions/compare/v1.5.2...v1.6.0
 [1.5.2]: https://github.com/dflook/terraform-github-actions/compare/v1.5.1...v1.5.2
 [1.5.1]: https://github.com/dflook/terraform-github-actions/compare/v1.5.0...v1.5.1
 [1.5.0]: https://github.com/dflook/terraform-github-actions/compare/v1.4.2...v1.5.0

image/tools/github_pr_comment.py

@@ -5,6 +5,7 @@
 import re
 import sys
 import datetime
+import hashlib
 from typing import Optional, Dict, Iterable
 
 import requests
@@ -98,25 +99,50 @@ def find_pr() -> str:
         raise Exception(f"The {event_type} event doesn\'t relate to a Pull Request.")
 
 def current_user() -> str:
+
+    token_hash = hashlib.sha256(os.environ["GITHUB_TOKEN"].encode()).hexdigest()
+
+    try:
+        with open(f'.dflook-terraform/token-cache/{token_hash}') as f:
+            username = f.read()
+            debug(f'GITHUB_TOKEN username: {username}')
+            return username
+    except Exception as e:
+        debug(str(e))
+
     response = github_api_request('get', 'https://api.github.com/user')
     if response.status_code != 403:
         user = response.json()
         debug('GITHUB_TOKEN user:')
         debug(json.dumps(user))
 
-        return user['login']
+        username = user['login']
+    else:
+        # Assume this is the github actions app token
+        username = 'github-actions[bot]'
 
-    # Assume this is the github actions app token
-    return 'github-actions[bot]'
+    try:
+        os.makedirs('.dflook-terraform/token-cache', exist_ok=True)
+        with open(f'.dflook-terraform/token-cache/{token_hash}', 'w') as f:
+            f.write(username)
+    except Exception as e:
+        debug(str(e))
+
+    debug(f'GITHUB_TOKEN username: {username}')
+    return username
 
 class TerraformComment:
     """
     The GitHub comment for this specific terraform plan
     """
 
-    def __init__(self, pr_url: str):
+    def __init__(self, pr_url: str=None):
         self._plan = None
         self._status = None
+        self._comment_url = None
+
+        if pr_url is None:
+            return
 
         response = github_api_request('get', pr_url)
         response.raise_for_status()
@@ -125,20 +151,20 @@ def __init__(self, pr_url: str):
         response = github_api_request('get', self._issue_url)
         response.raise_for_status()
 
-        self._comment_url = None
+        username = current_user()
+
         debug('Looking for an existing comment:')
         for comment in response.json():
             debug(json.dumps(comment))
-            if comment['user']['login'] == current_user():
-                match = re.match(rf'{re.escape(self._comment_identifier)}\n```(?:hcl)?(.*?)```(.*)', comment['body'], re.DOTALL)
+            if comment['user']['login'] == username:
+                match = re.match(rf'{re.escape(self._comment_identifier)}.*```(?:hcl)?(.*?)```.*', comment['body'], re.DOTALL)
 
                 if not match:
-                    match = re.match(rf'{re.escape(self._old_comment_identifier)}\n```(.*?)```(.*)', comment['body'], re.DOTALL)
+                    match = re.match(rf'{re.escape(self._old_comment_identifier)}\n```(.*?)```.*', comment['body'], re.DOTALL)
 
                 if match:
                     self._comment_url = comment['url']
                     self._plan = match.group(1).strip()
-                    self._status = match.group(2).strip()
                     return
 
     @property
@@ -270,12 +296,64 @@ def status(self) -> Optional[str]:
     def status(self, status: str) -> None:
         self._status = status.strip()
 
-    def update_comment(self):
+    def body(self) -> str:
         body = f'{self._comment_identifier}\n```hcl\n{self.plan}\n```'
 
         if self.status:
             body += '\n' + self.status
 
+        return body
+
+    def collapsable_body(self) -> str:
+
+        try:
+            collapse_threshold = int(os.environ['TF_PLAN_COLLAPSE_LENGTH'])
+        except (ValueError, KeyError):
+            collapse_threshold = 10
+
+        open = ''
+        highlighting = ''
+
+        if self.plan.startswith('Error'):
+            open = ' open'
+        elif 'Plan:' in self.plan:
+            highlighting = 'hcl'
+            num_lines = len(self.plan.splitlines())
+            if num_lines < collapse_threshold:
+                open = ' open'
+
+        body = f'''{self._comment_identifier}
+<details{open}>
+  <summary>{self.summary()}</summary>
+
+```{highlighting}
+{self.plan}
+```
+</details>
+'''
+
+        if self.status:
+            body += '\n' + self.status
+
+        return body
+
+    def summary(self) -> str:
+        summary = None
+
+        for line in self.plan.splitlines():
+            if line.startswith('No changes') or line.startswith('Error'):
+                return line
+
+            if line.startswith('Plan:'):
+                summary = line
+
+            if line.startswith('Changes to Outputs'):
+                return summary + ' Changes to Outputs.'
+
+        return summary
+
+    def update_comment(self):
+        body = self.collapsable_body()
         debug(body)
 
         if self._comment_url is None:
@@ -313,5 +391,6 @@ def update_comment(self):
         if tf_comment.plan is None:
             exit(1)
         print(tf_comment.plan)
+        exit(0)
 
     tf_comment.update_comment()

terraform-plan/README.md

@@ -100,6 +100,21 @@ The [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
   env:
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   ```
+  
+* `TF_PLAN_COLLAPSE_LENGTH`
+
+  When PR comments are enabled, the terraform output is included in a collapsable pane.
+  
+  If a terraform plan has fewer lines than this value, the pane is expanded
+  by default when the comment is displayed.
+
+  ```yaml
+  env:
+    TF_PLAN_COLLAPSE_LENGTH: 30
+  ```
+
+  - Optional
+  - Default: 10
 
 ## Outputs
 

terraform-version/README.md

@@ -70,5 +70,5 @@ jobs:
         run: echo "The terraform version was ${{ steps.terraform-version.outputs.terraform }}"
 
       - name: Print aws provider version
-        run: echo "The terraform version was ${{ steps.terraform-version.outputs.aws }}"        
+        run: echo "The aws provider version was ${{ steps.terraform-version.outputs.aws }}"        
 ```

tests/requirements.txt

@@ -0,0 +1,2 @@
+requests
+pytest