Merge pull request #1782 from atlassian/confluence-apps-count

Confluence apps count

Author: SergeyMoroz0703

app/util/analytics/analytics_utils.py

@@ -7,7 +7,7 @@
 
 from datetime import datetime, timezone
 from util.common_util import get_current_version, get_latest_version
-from util.analytics.application_info import BITBUCKET, BAMBOO, CROWD, INSIGHT, JSM, CONFLUENCE
+from util.analytics.application_info import BITBUCKET, BAMBOO, CROWD, INSIGHT, JSM, CONFLUENCE, JIRA
 
 latest_version = get_latest_version()
 current_version = get_current_version()
@@ -106,9 +106,11 @@ def generate_report_summary(collector):
     summary_report.append(f'Compliant|{compliant}')
     summary_report.append(f'Success|{success}')
     summary_report.append(f'Has app-specific actions|{bool(collector.app_specific_rates)}')
-    summary_report.append(f'Applications count|{collector.apps_count}')
-    summary_report.append(f'Custom applications count|{collector.custom_apps_count}')
-    summary_report.append(f'Custom applications count enabled|{collector.custom_apps_count_enabled}')
+
+    if collector.app_type in [JIRA, JSM, CONFLUENCE]:
+        summary_report.append(f'Applications count|{collector.apps_count}')
+        summary_report.append(f'Custom applications count|{collector.custom_apps_count}')
+        summary_report.append(f'Custom applications count enabled|{collector.custom_apps_count_enabled}')
 
     if collector.app_type == JSM:
         insight = collector.insight

app/util/analytics/application_info.py

@@ -159,6 +159,36 @@ def java_version(self):
             return java_versions_parsed[0].text
         return None
 
+    @property
+    def apps_count(self):
+        return len(self.__get_apps)
+
+    @cached_property
+    def __get_apps(self):
+        try:
+            return self.client.get_installed_apps()
+        except Exception as e:
+            print(f'ERROR: Could not get the installed applications. Error: {e}')
+            return []
+
+    @cached_property
+    def __get_custom_apps(self):
+        all_apps = self.__get_apps
+        apps_with_vendor_defined = [app for app in all_apps if 'vendor' in app]
+        non_atlassian_apps = [app for app in apps_with_vendor_defined if 'Atlassian' not in
+                              app['vendor']['name'] and app['userInstalled'] == True]
+        return non_atlassian_apps
+
+    @property
+    def custom_app_count(self):
+        return len(self.__get_custom_apps)
+
+    @property
+    def custom_app_count_enabled(self):
+        non_atlassian_apps = self.__get_custom_apps
+        non_atlassian_apps_enabled = [app for app in non_atlassian_apps if app['enabled'] == True]
+        return len(non_atlassian_apps_enabled)
+
 
 class Bitbucket(BaseApplication):
     type = BITBUCKET

app/util/api/confluence_clients.py

@@ -222,6 +222,13 @@ def get_system_info_page(self):
         system_info_html = self.session.post(url=auth_url, data=auth_body, headers={'X-Atlassian-Token': 'no-check'}, verify=self.verify)
         return system_info_html.content.decode("utf-8")
 
+    def get_installed_apps(self):
+        plugins_url = f'{self.host}/rest/plugins/1.0/'
+        r = self.get(plugins_url, error_msg="ERROR: Could not get installed plugins.",
+                     headers={'X-Atlassian-Token': 'no-check'})
+        return r.json()['plugins']
+
+
     def get_deployment_type(self):
         html_pattern = 'deployment=terraform'
         confluence_system_page = self.get_system_info_page()

app/util/data_preparation/confluence_prepare_data.py

@@ -247,6 +247,20 @@ def __check_license(rest_client):
     print(f"The license expiry date: {expiry_date_human}.\n"
           f"License available seats: {license_remaining_seats['count']}")
 
+def __check_number_of_custom_app(rest_client):
+    try:
+        all_apps = rest_client.get_installed_apps()
+        apps_with_vendor_defined = [app for app in all_apps if 'vendor' in app]
+        non_atlassian_apps = [app for app in apps_with_vendor_defined if 'Atlassian' not in
+                              app['vendor']['name'] and app['userInstalled'] == True]
+        non_atlassian_apps_names = [app['name'] for app in non_atlassian_apps]
+        print(f"Custom application count: {len(non_atlassian_apps)}")
+        if non_atlassian_apps:
+            print(f'Custom app names:')
+            print(*non_atlassian_apps_names, sep='\n')
+    except Exception as e:
+        print(f'ERROR: Could not get the installed applications. Error: {e}')
+
 
 @print_timing('Confluence data preparation')
 def main():
@@ -258,6 +272,7 @@ def main():
     rest_client = ConfluenceRestClient(url, CONFLUENCE_SETTINGS.admin_login, CONFLUENCE_SETTINGS.admin_password,
                                        verify=CONFLUENCE_SETTINGS.secure)
     rpc_client = ConfluenceRpcClient(url, CONFLUENCE_SETTINGS.admin_login, CONFLUENCE_SETTINGS.admin_password)
+    __check_number_of_custom_app(rest_client)
     __is_remote_api_enabled(rest_client)
     __check_license(rest_client)
     __check_for_admin_permissions(rest_client)

app/util/data_preparation/jira_prepare_data.py

@@ -185,8 +185,9 @@ def __check_number_of_custom_app(client):
                               app['vendor']['name'] and app['userInstalled'] == True]
         non_atlassian_apps_names = [app['name'] for app in non_atlassian_apps]
         print(f"Custom application count: {len(non_atlassian_apps)}")
-        print(f'Custom app names:')
-        print(*non_atlassian_apps_names, sep='\n')
+        if non_atlassian_apps:
+            print(f'Custom app names:')
+            print(*non_atlassian_apps_names, sep='\n')
     except Exception as e:
         print(f'ERROR: Could not get the installed applications. Error: {e}')