Merge pull request #1780 from atlassian/apps-count-for-jira

added apps count to analytics

Author: SergeyMoroz0703

app/util/analytics/analytics.py

@@ -52,6 +52,9 @@ def __init__(self, application: BaseApplication):
         self.application_version = application.version
         self.nodes_count = application.nodes_count
         self.dataset_information = application.dataset_information
+        self.apps_count = application.apps_count
+        self.custom_apps_count = application.custom_app_count
+        self.custom_apps_count_enabled = application.custom_app_count_enabled
         if self.app_type != CROWD:
             self.processors = application.processors
             self.deployment = application.deployment

app/util/analytics/analytics_utils.py

@@ -106,6 +106,9 @@ 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 == JSM:
         insight = collector.insight

app/util/analytics/application_info.py

@@ -8,6 +8,7 @@
 from util.api.bamboo_clients import BambooClient
 import json
 from lxml import html
+from functools import cached_property
 
 JIRA = 'jira'
 CONFLUENCE = 'confluence'
@@ -31,6 +32,9 @@ class BaseApplication:
     version = None
     nodes_count = None
     dataset_information = None
+    apps_count = None
+    custom_app_count = None
+    custom_app_count_enabled = None
 
     def __init__(self, api_client, config_yml):
         self.client = api_client(host=config_yml.server_url,
@@ -99,6 +103,36 @@ def __issues_count(self):
     def dataset_information(self):
         return f"{self.__issues_count()} issues"
 
+    @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 Confluence(BaseApplication):
     type = CONFLUENCE

app/util/api/jira_clients.py

@@ -300,3 +300,21 @@ def get_license_details(self):
                                  'image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7'
         r = self.get(api_url, "Could not retrieve license details")
         return r.json()
+
+    def get_installed_apps(self):
+        login_url = f'{self.host}/login.jsp'
+        auth_url = f'{self.host}/secure/admin/WebSudoAuthenticate.jspa'
+        auth_body = {
+            'webSudoDestination': '/secure/admin/ViewSystemInfo.jspa',
+            'webSudoIsPost': False,
+            'webSudoPassword': self.password
+        }
+        self.post(login_url, error_msg='Could not login in')
+        auth_body['atl_token'] = self.session.cookies.get_dict()['atlassian.xsrf.token']
+        self._session.post(auth_url, data=auth_body)
+        self.headers['Accept'] = 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,' \
+                                 'image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7'
+
+        api_url = f'{self.host}/rest/plugins/1.0/'
+        r = self.get(api_url, error_msg="ERROR: Could not get the installed apps.")
+        return r.json()['plugins']

app/util/data_preparation/jira_prepare_data.py

@@ -177,6 +177,21 @@ def __check_license(client):
         raise SystemExit(f'ERROR: Jira license is valid: {license_valid}, license has expired: {license_expired}.')
 
 
+def __check_number_of_custom_app(client):
+    try:
+        all_apps = 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)}")
+        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}')
+
+
+
 def main():
     print("Started preparing data")
 
@@ -188,6 +203,7 @@ def main():
     __check_for_admin_permissions(client)
     __check_current_language(client)
     __check_license(client)
+    __check_number_of_custom_app(client)
     dataset = __create_data_set(client)
     write_test_data_to_files(dataset)