From 5a2091c1b0d85c15d01c22e40752950a1a6cd464 Mon Sep 17 00:00:00 2001
From: Lucas Benedito <lbenedit@redhat.com>
Date: Wed, 1 May 2024 17:43:13 +0100
Subject: Adding the plugin 'aap_gateway.py' for the sos report to collect the
 files used for troubleshooting issues at Ansible Automation Platform Gateway

Related: RH AAP-20033

Signed-off-by: Lucas Benedito <lbenedit@redhat.com>
---
 sos/report/plugins/aap_gateway.py | 53 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 sos/report/plugins/aap_gateway.py

diff --git a/sos/report/plugins/aap_gateway.py b/sos/report/plugins/aap_gateway.py
new file mode 100644
index 00000000..fffc6c17
--- /dev/null
+++ b/sos/report/plugins/aap_gateway.py
@@ -0,0 +1,53 @@
+# Copyright (c) 2024 Lucas Benedito <lbenedit@redhat.com>
+
+# This file is part of the sos project: https://github.com/sosreport/sos
+#
+# This copyrighted material is made available to anyone wishing to use,
+# modify, copy, or redistribute it subject to the terms and conditions of
+# version 2 of the GNU General Public License.
+#
+# See the LICENSE file in the source distribution for further information.
+
+from sos.report.plugins import Plugin, RedHatPlugin
+
+
+class AAPGatewayPlugin(Plugin, RedHatPlugin):
+    short_desc = 'AAP Gateway plugin'
+    plugin_name = 'aap_gateway'
+    profiles = ('sysmgmt', 'ansible',)
+
+    packages = ('automation-gateway',
+                'automation-gateway-config')
+    commands = ('aap-gateway-manage',)
+    services = ('automation-gateway',)
+
+    def setup(self):
+        self.add_copy_spec([
+            "/var/log/supervisor",
+            "/etc/ansible-automation-platform",
+            "/etc/supervisord.d/",
+            "/var/log/ansible-automation-platform/gateway/",
+        ])
+
+        self.add_forbidden_path([
+            "/etc/ansible-automation-platform/gateway/SECRET_KEY",
+            "/etc/ansible-automation-platform/gateway/*.key",
+            "/etc/ansible-automation-platform/gateway/*.cert",
+        ])
+
+        self.add_cmd_output([
+            "aap-gateway-manage list_services",
+            "ls -ll /etc/ansible-automation-platform/",
+            "ls -ll /etc/ansible-automation-platform/gateway/",
+        ])
+
+    def postproc(self):
+        # remove database password
+        jreg = r"(DATABASE_PASSWORD)(\s*)(=|:)(\s*)(.*)"
+        repl = r"\1\2\3\4********"
+        self.do_path_regex_sub(
+            "/etc/ansible-automation-platform/gateway/settings.py",
+            jreg,
+            repl)
+
+# vim: set et ts=4 sw=4 :
-- 
cgit