Merge branch 'main' into add_cloud_environments

Reviewed-on: #44
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>

.gitea/workflows/create-weekly-analytics-stats.yaml

@@ -0,0 +1,62 @@
+name: Create Weekly Analytics Stats
+
+on:
+  schedule:
+    # 03:00 UTC = 04:00 CET
+    - cron: "0 3 * * 1"
+  workflow_dispatch:
+
+jobs:
+  run-analytics:
+    runs-on: ubuntu
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PUSH_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests otc-metadata
+
+      - name: Run analytics for eu_de
+        env:
+          UMAMI_USERNAME: ${{ secrets.UMAMI_USERNAME }}
+          UMAMI_PASSWORD: ${{ secrets.UMAMI_PASSWORD }}
+        run: |
+          python ./tools/collect_statistics.py \
+            --website-id "${{ secrets.UMAMI_WEBSITE_ID }}" \
+            --cloud-environment "eu_de" \
+            --environment "public" \
+            --limit "10"
+
+      - name: Run analytics for swiss
+        env:
+          UMAMI_USERNAME: ${{ secrets.UMAMI_USERNAME }}
+          UMAMI_PASSWORD: ${{ secrets.UMAMI_PASSWORD }}
+        run: |
+          python ./tools/collect_statistics.py \
+            --website-id "${{ secrets.UMAMI_WEBSITE_ID }}" \
+            --cloud-environment "swiss" \
+            --environment "public" \
+            --limit "10"
+
+      - name: Commit and push results
+        run: |
+          git config --global user.name "gitea-actions[bot]"
+          git config --global user.email "actions@users.noreply.local"
+          git checkout -B analytics-update
+          git add otc_metadata/analytics/
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "chore: update analytics data [skip ci]"
+            git push origin analytics-update --force
+          fi

README.rst

@@ -52,4 +52,3 @@ the key is :code:`service_type` which has the foreign key in the
 document can only be linked to one service.
 The key :code:`service_category` table is :code:`name` of the service category
 which is then used in the :code:`services` table as foreign key.
-

otc_metadata/analytics/data.py

@@ -0,0 +1,47 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pathlib import Path
+import json
+
+analytics_path = Path("otc_metadata/analytics/public")
+
+cloud_environments = [
+    'eu_de',
+    'swiss'
+]
+analytics_data = {k: [] for k in cloud_environments}
+
+# Open and read the json data files
+for env in cloud_environments:
+    file_path = analytics_path.joinpath(f"{env}.json")
+    with open(file_path, 'r') as file:
+        analytics_data[env] = json.load(file)
+
+
+class AnalyticsData(object):
+    """Encapsulate OTC Analystics data"""
+
+    def __init__(self):
+        self._analytics_data = analytics_data
+
+    def all_analytics_data(self):
+        """returns all analytics data"""
+        return self._analytics_data
+
+    def analytics_data_by_cloud_environment(self, cloud_environment):
+        """returns all analytics data"""
+        if cloud_environment and cloud_environment in self._analytics_data:
+            return self._analytics_data[cloud_environment]
+        else:
+            raise ValueError(f"cloud_environment '{cloud_environment}' does not exist.")

otc_metadata/analytics/public/eu_de.json

@@ -0,0 +1,12 @@
+[
+  "evs",
+  "ims",
+  "ecs",
+  "cce",
+  "obs",
+  "rds",
+  "sfs",
+  "iam",
+  "elb",
+  "apig"
+]

otc_metadata/analytics/public/swiss.json

@@ -0,0 +1,12 @@
+[
+  "evs",
+  "ims",
+  "ecs",
+  "cce",
+  "obs",
+  "rds",
+  "iam",
+  "elb",
+  "cbr",
+  "vpc"
+]

otc_metadata/data/cloud_environments/eu_de.yaml

@@ -0,0 +1,2 @@
+---
+name: eu_de

otc_metadata/data/cloud_environments/swiss.yaml

@@ -0,0 +1,2 @@
+---
+name: swiss

otc_metadata/data/services.yaml

@@ -17,6 +17,7 @@
 # documents/services/service_categories is being merged with
 # the content here.
 ---
+cloud_environments: []
 documents: []
 service_categories: []
 services: []

otc_metadata/services.py

@@ -62,10 +62,20 @@ class Services(object):
         if other in self._service_data["service_categories"]:
             self._service_data["service_categories"].remove(other)
             self._service_data["service_categories"].append(other)
+        # sort cloud environments by <name>
+        self._service_data["cloud_environments"] = sorted(
+            self._service_data["cloud_environments"],
+            key=lambda x: f"{x.get('name')}",
+        )
 
     def _rewrite_data(self):
         otc_metadata.data.rewrite_data("services.yaml", self._service_data)
 
+    @property
+    def all_cloud_environments(self):
+        "Cloud Environments data listing."
+        return copy.deepcopy(self._service_data["cloud_environments"])
+
     @property
     def all_services(self):
         "Service Categories data listing."
@@ -453,3 +463,25 @@ class Services(object):
         res.sort(key=lambda x: x.get("name", "").lower())
 
         return res
+
+    def all_services_by_cloud_environment(self, cloud_environment, environments):
+        """Retrieve all services filtered by cloud_environment
+        """
+        res = []
+        for srv in self.all_services:
+            if environments and cloud_environment:
+                for srv_cloud_environment in srv["cloud_environments"]:
+                    if srv_cloud_environment["name"] == cloud_environment:
+                        for environment in environments:
+                            if srv_cloud_environment["visibility"] == environment:
+                                res.append(srv)
+                    else:
+                        continue
+            else:
+                raise Exception("No cloud_environment or environments "
+                                "specified in function all_services_by_cloud_environment.")
+
+        # Sort services
+        res.sort(key=lambda x: x.get("service_title", "").lower())
+
+        return res