Merge pull request #16 from holgerson97/dev

Added: Now collects resources
holgerson97 · Jul 2, 2021 · a01c755 · a01c755
2 parents 047d1b8 + 9a5a4c3
commit a01c755
Show file tree

Hide file tree

Showing 9 changed files with 134 additions and 11 deletions.
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -58,4 +58,9 @@ jobs:
       - name: Test with pytest
         run: |
           pip install pytest
-          cd src/ && pytest
+          cd src/ && pytest
+      
+      - name: Print Sample and test file
+        run: |
+          cat tests/README.md
+          cat tests/samples/README.md
diff --git a/src/iterateTerraformFiles.py b/src/iterateTerraformFiles.py
@@ -128,7 +128,7 @@ def createOutput(tfObject):
             outObject.update({'name': tfName})
         except (ValueError, IndexError):
             print('Output name not found for:\n' + tfObject +
-                '\n Please make sure, that your configuration is valid.')
+                  '\n Please make sure, that your configuration is valid.')
 
         # Get description from tfObject
         try:
@@ -145,7 +145,7 @@ def createOutput(tfObject):
             outObject.update({'Value': tfValue})
         except (ValueError, IndexError):
             print('Value not specified for output object:\n' + tfObject +
-                '\n Please make sure, that your configuration is valid.')
+                  '\n Please make sure, that your configuration is valid.')
 
         # Get sensitive from tfObject
         try:
@@ -207,6 +207,20 @@ def createVersion(tfObject):
 
         return verObject
 
+    def createResource(tfObject):
+        '''
+        Create a dict for every
+        '''
+
+        # Get Resource name from object
+        try:
+            tfResource = findall('^resource\\s\"(\\w*)\"', tfObject)[0]
+        except (ValueError, IndexError):
+            print('Resource definition not valid:\n' + tfObject +
+                  '\n Please make sure, that your configuration is valid.')
+
+        return tfResource
+
     def getTerraformObjects(tfFile):
         '''
         Iterate through Terraform files and get all objects.
@@ -227,7 +241,12 @@ def getTerraformObjects(tfFile):
                 tfVersion = captureCurlyBraces(tfLines, i)
                 struc['versions'].append(createVersion(tfVersion))
 
-    struc = {'variables': [], 'outputs': [], 'versions': []}
+            elif match('^resource\\s+', tfLines[i]):
+                tfResource = createResource(tfLines[i])
+                struc['resources'].append(
+                    tfResource) if tfResource not in struc['resources'] else struc['resources']
+
+    struc = {'resources': ([]), 'variables': [], 'outputs': [], 'versions': []}
 
     for i in lookupFiles():
         getTerraformObjects(i)

diff --git a/src/main.py b/src/main.py
@@ -19,6 +19,8 @@ def main():
                 args.requirements,
                 args.gettingstarted,
                 struc['versions'],
+                struc['resources'],
+                args.resources,
                 struc['variables'],
                 args.variables,
                 struc['outputs'],
@@ -51,6 +53,13 @@ def main():
         help='Choose if you want to display a table of contents. \
               Defaults to true.')
 
+    parser.add_argument(
+        '--resources',
+        type=bool,
+        default=True,
+        help='Choose if you want to display resources. \
+              Defaults to true.')
+
     parser.add_argument(
         '--variables',
         type=bool,

diff --git a/src/renderReadMe.py b/src/renderReadMe.py
@@ -7,6 +7,8 @@ def render(
         requirements,
         gettingStarted,
         versions,
+        res,
+        resStatement,
         vars,
         varsstatement,
         outs,
@@ -22,6 +24,8 @@ def render(
         gettingStarted=gettingStarted,
         terraformVersion=versions[0],
         versions=versions[0]['Modules'],
+        resources=res,
+        resourcesStatement=resStatement,
         variables=vars,
         varsstatement=varsstatement,
         outputs=outs,

diff --git a/src/templates/readme.j2 b/src/templates/readme.j2
@@ -1,4 +1,6 @@
 # {{ name }}
+
+&nbsp;
 {% if tableOfContents == true %}
 # Table of Contents
 {% if requirements == true %}
@@ -9,6 +11,9 @@
     - [Basic usage](#basic-usage)
     - [Custom usage](#custom-usage)
 {%- endif -%}
+{% if resourceStatement == true %}
+- [Resources](#resources)
+{%- endif -%}
 {% if varsstatement == true %}
 - [Variables](#variables)
 {%- endif -%}
@@ -18,8 +23,8 @@
 &nbsp;
 - [Contributing](#contributing)
 {%- endif -%}
-
 {% if requirements == true %}
+
 &nbsp;
 # Requirements
 | Software     |  Version  | Source |
@@ -31,8 +36,21 @@
 {{ buildRequirements(items.name, items.version, items.source) }}
 {%- endfor %}
 {%- endif -%}
+{% if resourcesStatement == true %}
 
+&nbsp;
+# Resources
+| Resource |
+| :------- |
+{%- macro buildResources(name) -%}
+| `{{name}}` |
+{%- endmacro -%}
+{% for items in resources %}
+{{ buildResources(items) }}
+{%- endfor %}
+{%- endif -%}
 {% if varsstatement == true %}
+
 &nbsp;
 # Variables
 | Variable | Type | Default | Description | Sensitive |
@@ -44,8 +62,8 @@
 {{ buildVars(items.name, items.type, items.default, items.description, items.sensitive) }}
 {%- endfor %}
 {%- endif -%}
-
 {% if outsstatement == true %}
+
 &nbsp;
 # Outputs
 | Output | Description |
@@ -57,7 +75,6 @@
 {{ buildOuts(items.name, items.description) }}
 {%- endfor %}
 {%- endif -%}
-
 &nbsp;
 ## Contributing
 {%- if contribute == True %}

diff --git a/src/test_prerendering.py b/src/test_prerendering.py
@@ -8,7 +8,9 @@ class TestRender(unittest.TestCase):
     def test_file(self):
 
         system('./main.py')
-        self.assertTrue(cmp('../tests/samples/README.md', '../tests/README.md'), "The to files aren't identical.")
+        self.assertTrue(cmp('../tests/samples/README.md',
+                            '../tests/README.md'),
+                        "The to files aren't identical.")
 
 
 if __name__ == '__main__':

diff --git a/tests/README.md b/tests/README.md
@@ -0,0 +1,53 @@
+# default_name
+
+&nbsp;
+
+# Table of Contents
+
+- [Requiremets](#requirements)
+- [Getting Started](#getting-started)
+    - [Basic usage](#basic-usage)
+    - [Custom usage](#custom-usage)
+- [Variables](#variables)
+- [Outputs](#outputs)&nbsp;
+- [Contributing](#contributing)
+
+&nbsp;
+# Requirements
+| Software     |  Version  | Source |
+| :--------    | :-------- | :----- |
+| random | 3.1.0 | hashicorp/random |
+| template | 2.2.0 | hashicorp/template |
+
+&nbsp;
+# Resources
+| Resource |
+| :------- |
+| `random_resource1` |
+| `random_resource2` |
+| `random_resource3` |
+
+&nbsp;
+# Variables
+| Variable | Type | Default | Description | Sensitive |
+| :------- | :--: | :------ | :---------- | :-------- |
+| `in_main_file` | string | Value | Just antoher number. |  |
+| `empty` |  |  |  |  |
+| `oneline1` |  |  | Description |  |
+| `multiline1` |  |  | Just antoher number. |  |
+| `multiline2` |  | Value | Just antoher number. |  |
+| `multiline3` | string | Value | Just antoher number. |  |
+| `multiline4` | string | Value | Just antoher number. | true |
+| `object` | object({    key   = string    value = number  }) | {    key   = "integer"    value = 1  } | Just an object. | true |
+
+&nbsp;
+# Outputs
+| Output | Description |
+| :----- | :---------- |
+| `oneline1` |  |
+| `multiline1` |  |
+| `multiline2` | Description |
+| `multiline3` | Description |
+| `multiline4` | Description |&nbsp;
+## Contributing
+Feel free to create pull requests.
diff --git a/tests/main.tf b/tests/main.tf
@@ -1,4 +1,5 @@
 resource "random_resource1" "main" {}
+resource "random_resource1" "name" {}
 resource "random_resource2" "main" {}
 resource "random_resource3" "main" {}
 

diff --git a/tests/samples/README.md b/tests/samples/README.md
@@ -1,5 +1,7 @@
 # default_name
 
+&nbsp;
+
 # Table of Contents
 
 - [Requiremets](#requirements)
@@ -9,32 +11,43 @@
 - [Variables](#variables)
 - [Outputs](#outputs)&nbsp;
 - [Contributing](#contributing)
+
 &nbsp;
 # Requirements
 | Software     |  Version  | Source |
 | :--------    | :-------- | :----- |
 | random | 3.1.0 | hashicorp/random |
 | template | 2.2.0 | hashicorp/template |
+
+&nbsp;
+# Resources
+| Resource |
+| :------- |
+| `random_resource1` |
+| `random_resource2` |
+| `random_resource3` |
+
 &nbsp;
 # Variables
 | Variable | Type | Default | Description | Sensitive |
 | :------- | :--: | :------ | :---------- | :-------- |
-| `in_main_file` | string | Value | Just antoher number. |  |
 | `empty` |  |  |  |  |
 | `oneline1` |  |  | Description |  |
 | `multiline1` |  |  | Just antoher number. |  |
 | `multiline2` |  | Value | Just antoher number. |  |
 | `multiline3` | string | Value | Just antoher number. |  |
 | `multiline4` | string | Value | Just antoher number. | true |
 | `object` | object({    key   = string    value = number  }) | {    key   = "integer"    value = 1  } | Just an object. | true |
+| `in_main_file` | string | Value | Just antoher number. |  |
+
 &nbsp;
 # Outputs
 | Output | Description |
 | :----- | :---------- |
-| `multiline4` | Description |
 | `oneline1` |  |
 | `multiline1` |  |
 | `multiline2` | Description |
-| `multiline3` | Description |&nbsp;
+| `multiline3` | Description |
+| `multiline4` | Description |&nbsp;
 ## Contributing
 Feel free to create pull requests.