Add dry-run option to run without sending request

I've added a dry-run option that allows you to run the application
without actually sending the embed to Discord. This can be handy for
debugging or testing the application.

Author: SebastiaanZ

github_status_embed/__main__.py

@@ -45,15 +45,27 @@
 for argument, configuration in action_specs["inputs"].items():
     parser.add_argument(argument, help=configuration["description"])
 
-parser.add_argument("--debug", help="enable debug logging", action="store_true", dest="debug")
+parser.add_argument(
+    "--debug",
+    help="enable debug logging",
+    action="store_true",
+    dest="debug",
+)
+parser.add_argument(
+    "--dry-run",
+    help="do not send webhook request",
+    action="store_true",
+    dest="dry_run"
+)
 
 
 if __name__ == "__main__":
     arguments = vars(parser.parse_args())
     debug = arguments.pop('debug')
+    dry_run = arguments.pop('dry_run')
 
     # Set up logging and make sure to mask the webhook_token in log records
-    level = logging.DEBUG if debug else logging.ERROR
+    level = logging.DEBUG if debug else logging.WARNING
     setup_logging(level, masked_values=[arguments['webhook_token']])
 
     # If debug logging is requested, enable it for our application only
@@ -67,7 +79,7 @@
     pull_request = PullRequest.from_arguments(arguments)
 
     # Send webhook
-    success = send_webhook(workflow, webhook, pull_request)
+    success = send_webhook(workflow, webhook, pull_request, dry_run)
 
     if not success:
         log.debug("Exiting with status code 1")

github_status_embed/webhook.py

@@ -113,6 +113,7 @@ def send_webhook(
         workflow: types.Workflow,
         webhook: types.Webhook,
         pull_request: typing.Optional[types.PullRequest],
+        dry_run: bool = False,
 ) -> bool:
     """Send an embed to specified webhook."""
     if pull_request is None:
@@ -124,6 +125,9 @@ def send_webhook(
 
     log.debug("Generated payload:\n%s", json.dumps(payload, indent=4))
 
+    if dry_run:
+        return True
+
     response = requests.post(webhook.url, json=payload)
 
     log.debug(f"Response: [{response.status_code}] {response.reason}")