Merge pull request #10 from fergusmacd/feature/datetime

Adding date time to output

Author: mononokehime

Dockerfile

@@ -12,8 +12,4 @@ FROM gcr.io/distroless/python3-debian11
 COPY --from=builder /app /app
 WORKDIR /app
 ENV PYTHONPATH /app
-# strictly speaking not necessary but makes it easier if working out what is happening
-# Useful when running locally
-ENV INPUT_ORGANISATION=
-ENV INPUT_GITHUBAPIKEY=
 CMD ["/app/python/main.py"]

docs/README.md

@@ -71,34 +71,100 @@ in the prettyprint formatted ASCII tables like this
 
 ## Usage
 
+### As a GitHub Action
+
+Create a file called `gha-audit.yml` in your `workflows` directory, paste the following as the contents and you are good
+to go
+
+```
+name: GHA Billable Audit
+on: push
+jobs:
+  gha-billable-minutes-report:
+    runs-on: ubuntu-latest
+    steps:
+      - name: GitHub Actions Billable Usage Audit
+        uses: fergusmacd/github-action-usage@v0.4.0
+        # pass user input as arguments
+        with:
+          organisation: ${{secrets.ORGANISATION}}
+          gitHubAPIKey: ${{secrets.GITHUBAPIKEY}} # default token in GitHub Workflow
+          loglevel: error # not required, change to debug if misbehaving
+```
+
 ### Running Locally
 
 The docker file and python script can both be run locally in the following ways.
 
+### Running with Python
+
 For python, from the python directory
 
-```
+```shell
 pip install -r requirements.txt
 # default is warning, see the action.yaml for further details
-export LOGLEVEL=debug|info|warning|error
+# GHA environment variables prepend INPUT_ to values passed in
+export INPUT_LOGLEVEL=debug|info|warning|error
 export INPUT_ORGANISATION="myorg"
 export INPUT_GITHUBAPIKEY="***"
 
 # from python directory you can run
 python main.py
 ```
 
+### Running with Docker
+
 For Docker, run from the root directory
 
-```
+```shell
 # from root directory
 docker build -t gha-billable-usage .
-
-export LOGLEVEL=debug|info|warning|error
+# GHA environment variables prepend INPUT_ to values passed in
+export INPUT_LOGLEVEL=debug|info|warning|error
 export INPUT_ORGANISATION="myorg"
 export INPUT_GITHUBAPIKEY="***"
-docker run -v $PWD:/app/results -e LOGLEVEL=${LOGLEVEL} -e INPUT_ORGANISATION=${INPUT_ORGANISATION} -e INPUT_GITHUBAPIKEY=${INPUT_GITHUBAPIKEY} -it gha-billable-usage
+docker run -v $PWD:/app/results -e INPUT_LOGLEVEL=${INPUT_LOGLEVEL} -e INPUT_ORGANISATION=${INPUT_ORGANISATION} -e INPUT_GITHUBAPIKEY=${INPUT_GITHUBAPIKEY} -it gha-billable-usage
+```
+
+## Common Errors
+
+When problems happen, the best thing to do is set the log level to `debug` like this locally
+
+```shell
+export LOGLEVEL="debug"
+```
+
+Or change the loglevel input in the GHA
+
+The following one happens when running locally and the `INPUT_GITHUBAPIKEY` environment variable has not been exported
+
+```shell
+python3 main.py
+Traceback (most recent call last):
+  File "/github-action-usage/python/main.py", line 5, in <module>
+    from ghaworkflows import *
+  File "/github-action-usage/python/ghaworkflows.py", line 9, in <module>
+    github_api_key = getgithubapikey()
+  File "/github-action-usage/python/common.py", line 24, in getgithubapikey
+    return os.environ['INPUT_GITHUBAPIKEY']
+  File "/usr/local/Cellar/python@3.9/3.9.12/Frameworks/Python.framework/Versions/3.9/lib/python3.9/os.py", line 679, in __getitem__
+    raise KeyError(key) from None
+KeyError: 'INPUT_GITHUBAPIKEY'
+
+```
 
+This error happens when the PAT has expired or does not have sufficient permissions
+
+```shell
+python3 main.py                                                     
+Traceback (most recent call last):
+  File "/github-action-usage/python/main.py", line 92, in <module>
+    main()
+  File "/github-action-usage/python/main.py", line 30, in main
+    repoNames = getreposfromorganisation(org)
+  File "/github-action-usage/python/ghorg.py", line 27, in getreposfromorganisation
+    totalPrivateRepos = json_data["total_private_repos"]
+KeyError: 'total_private_repos'
 ```
 
 ## Relevant Links
@@ -124,6 +190,7 @@ There are plenty of tutorials on prettyprint, I used this one:
 - export to excel and upload to packages
 - sorting by different criteria, e.g. tags or ownership
 - test coverage
+- test scripts
 - colouring console
 - any requests?
 

python/customlogger.py

@@ -6,10 +6,7 @@
 DEBUG_FORMAT = (
     "%(asctime)s [%(levelname)s]: %(message)s in %(pathname)s:%(lineno)d")
 
-AUDIT_FORMAT = (
-    "%(message)s")
-LOG_LEVEL = os.environ.get('LOGLEVEL', 'WARNING').upper()
-
+LOG_LEVEL = os.environ.get('INPUT_LOGLEVEL', 'WARNING').upper()
 # the debug logger is for figuring out what is going on
 debug_logger = logging.getLogger("debug")
 debug_logger.setLevel(LOG_LEVEL)
@@ -24,7 +21,7 @@ def getlogger():
 
 
 def main():
-    getlogger.error('Who knows where they got the money?!')
+    getlogger.error('The TV people are back!')
 
 
 if __name__ == "__main__":

python/ghaworkflows.py

@@ -2,9 +2,9 @@
 
 import requests
 
-from customlogger import getlogger
 # get any header or key values we need
-from python.common import getgithubapikey
+from common import getgithubapikey
+from customlogger import getlogger
 
 github_api_key = getgithubapikey()
 headers = {"Authorization": "token {}".format(github_api_key),

python/main.py

@@ -1,11 +1,12 @@
 # The starting point
 import os
+from datetime import datetime
 
 from prettytable import PrettyTable
 
-from python.customlogger import getlogger
-from python.ghaworkflows import getrepoworkflows
-from python.ghorg import getreposfromorganisation
+from customlogger import getlogger
+from ghaworkflows import getrepoworkflows
+from ghorg import getreposfromorganisation
 
 
 class RepoData:
@@ -24,6 +25,7 @@ def __init__(self, name, usage, actions):
 logger = getlogger()
 
 repo_name_column_header = "Repo Name"
+datetime_format = "%Y-%m-%d %H:%M"
 
 
 def main():
@@ -32,23 +34,23 @@ def main():
     logger.info(f'*************** Getting repos for {org} ***************')
     # Get all the repo names for the org, will page results too
     # repo names are returned sorted
-    repoNames = getreposfromorganisation(org)
+    repo_names = getreposfromorganisation(org)
 
-    reposUsage = []
-    totalCosts = dict.fromkeys(['UBUNTU', 'MACOS', 'WINDOWS'], 0)
+    repos_usage = []
+    total_costs = dict.fromkeys(['UBUNTU', 'MACOS', 'WINDOWS'], 0)
     # Collect the data from each repo
-    for repoName in repoNames:
+    for repo_name in repo_names:
         actions = []
-        repoData = RepoData(repoName, dict.fromkeys(['UBUNTU', 'MACOS', 'WINDOWS'], 0), actions)
-        logger.info(f"*************** Repo Name {repoData.name} ***************")
-        getrepoworkflows(org, repoData)
-        reposUsage.append(repoData)
-        logger.info(f"*************** Repo Usage Summary {repoData.usage} ***************")
-        totalCosts["UBUNTU"] += repoData.usage["UBUNTU"]
-        totalCosts["MACOS"] += repoData.usage["MACOS"]
-        totalCosts["WINDOWS"] += repoData.usage["WINDOWS"]
-
-    logger.info(f"***************Total Costs: {totalCosts} *******************")
+        repo_data = RepoData(repo_name, dict.fromkeys(['UBUNTU', 'MACOS', 'WINDOWS'], 0), actions)
+        logger.info(f"*************** Repo Name {repo_data.name} ***************")
+        getrepoworkflows(org, repo_data)
+        repos_usage.append(repo_data)
+        logger.info(f"*************** Repo Usage Summary {repo_data.usage} ***************")
+        total_costs["UBUNTU"] += repo_data.usage["UBUNTU"]
+        total_costs["MACOS"] += repo_data.usage["MACOS"]
+        total_costs["WINDOWS"] += repo_data.usage["WINDOWS"]
+
+    logger.info(f"***************Total Costs: {total_costs} *******************")
     # table tp print out per repo/workflow
     # Repo names are already sorted and we don't want to sort on tables
     # as order would mess up with totals
@@ -59,8 +61,8 @@ def main():
     summary_table: PrettyTable = PrettyTable()
     summary_table.field_names = [repo_name_column_header, "Ubuntu", "MacOS", "Windows"]
     summary_table.align[repo_name_column_header] = "l"
-
-    for repo in reposUsage:
+    validate_total_costs = dict.fromkeys(['UBUNTU', 'MACOS', 'WINDOWS'], 0)
+    for repo in repos_usage:
         summary_table.add_row([repo.name, repo.usage["UBUNTU"], repo.usage["MACOS"], repo.usage["WINDOWS"]])
         first_row: bool = True
         if not repo.actions:
@@ -70,14 +72,28 @@ def main():
                 workflow_table.add_row([repo.name, action.name, action.workflow['UBUNTU'], action.workflow['MACOS'],
                                         action.workflow['WINDOWS']])
                 first_row = False
+                validate_total_costs["UBUNTU"] += action.workflow["UBUNTU"]
+                validate_total_costs["MACOS"] += action.workflow["MACOS"]
+                validate_total_costs["WINDOWS"] += action.workflow["WINDOWS"]
             else:
                 workflow_table.add_row(["", action.name, action.workflow['UBUNTU'], action.workflow['MACOS'],
                                         action.workflow['WINDOWS']])
+                validate_total_costs["UBUNTU"] += action.workflow["UBUNTU"]
+                validate_total_costs["MACOS"] += action.workflow["MACOS"]
+                validate_total_costs["WINDOWS"] += action.workflow["WINDOWS"]
+
         workflow_table.add_row(["--------", "--------", "-----", "-----", "-----"])
 
     summary_table.add_row(["---------", "----", "----", "----"])
-    summary_table.add_row(["Total Costs", totalCosts["UBUNTU"], totalCosts["MACOS"], totalCosts["WINDOWS"]])
+    summary_table.add_row(
+        ["Billable Minutes " + datetime.now().strftime(datetime_format), total_costs["UBUNTU"],
+         total_costs["MACOS"],
+         total_costs["WINDOWS"]])
     summary_table.add_row(["---------", "----", "----", "----"])
+    workflow_table.add_row(["Billable Minutes " + datetime.now().strftime(datetime_format), "",
+                            validate_total_costs["UBUNTU"], validate_total_costs["MACOS"],
+                            validate_total_costs["WINDOWS"]])
+
     print(summary_table)
     print(workflow_table)