US001 E US004

.github/workflows/metrics.yml

@@ -25,7 +25,7 @@ jobs:
         run: |
           git config --global user.email "${{secrets.USER_EMAIL}}"
           git config --global user.name "${{secrets.USER_NAME}}"
-          git clone --single-branch --branch main "https://x-access-token:${{secrets.API_TOKEN_DOC}}@github.com/fga-eps-mds/2023.2-MeasureSoftGram-DOC" doc
+          git clone --single-branch --branch main "https://x-access-token:${{secrets.API_TOKEN_DOC}}@github.com/fga-eps-mds/2024.1-MeasureSoftGram-DOC" doc
           mkdir -p doc/analytics-raw-data
           cp -R analytics-raw-data/*.json doc/analytics-raw-data
           cd doc/

.github/workflows/python-publish.yml

@@ -33,5 +33,5 @@ jobs:
         run: python -m twine upload -u __token__ -p ${{ secrets.TEST_PYPI_API_TOKEN }} --repository testpypi dist/*
 
       - name: Publish package on pypi
-        #if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
         run: python -m twine upload -u __token__ -p ${{ secrets.PYPI_API_TOKEN }} dist/*

.github/workflows/test.yml

@@ -31,13 +31,13 @@ jobs:
         run: tox
 
       - name: Scanner do SonarCloud
-        uses: SonarSource/sonarcloud-github-action@v1.8
+        uses: SonarSource/sonarcloud-github-action@v2.3.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
       - name: Envia cobertura para o Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4.0.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           directory: ./

.gitignore

@@ -9,6 +9,8 @@ __pycache__/
 venv/
 ENV/
 .tox
+msgram-cli-venv
+.python-version
 
 # Distribution / packaging
 .Python
@@ -46,3 +48,9 @@ analytics-raw-data/
 **/*.log
 
 setup.py
+
+# Vim
+*.swp
+
+# ctags
+tags

README.md

@@ -1,5 +1,5 @@
-# 2023-2 MeasureSoftGram-CLI
-
+# 2024-1 MeasureSoftGram-CLI
+Command line project to MeasureSoftGram
 ## Badges
 
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=fga-eps-mds_2023-1-MeasureSoftGram-CLI&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=fga-eps-mds_2023-1-MeasureSoftGram-CLI)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "msgram"
-version = "3.1.9"
+version = "3.2.2"
 description = "The msgram CLI is a command-line interface to use MeasureSoftGram software"
 readme = "README.md"
 authors = [
@@ -20,20 +20,20 @@ classifiers = [
     "Topic :: Utilities",
 ]
 keywords = ["core", "measures", "quality", "algebraic model"]
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
-        "requests==2.28.1",
+        "requests~=2.32.3",
         "pytz",
         "typing~=3.7.4.3",
-        "tabulate==0.8.10",
-        "termcolor==1.1.0",
-        "pandas~=2.0.0",
-        "setuptools~=60.2.0",
+        "tabulate~=0.9.0",
+        "termcolor~=2.4.0",
+        "pandas~=2.2.2",
+        "setuptools~=72.1.0",
         "python-dotenv",
         "rich",
-        "validators==0.20.0",
-        "msgram-core==1.4.5",
-        "msgram-parser==1.1.3",
+        "validators~=0.33.0",
+        "msgram-core~=1.4.9",
+        "msgram-parser~=1.2.1",
         "anytree"
     ]
 

requirements.txt

@@ -1,15 +1,15 @@
 ###### Install local application in development mode. This will grab install_requires from setup.py.
 -e .
-requests~=2.28.1
-pandas~=2.0.0
+requests~=2.32.3
+pandas~=2.2.0
 typing~=3.7.4.3
-tabulate~=0.8.10
+tabulate~=0.9.0
 pytz~=2022.2.1
-termcolor~=1.1.0
-setuptools~=60.2.0
+termcolor~=2.4.0
+setuptools~=72.1.0
 python-dotenv
 rich
-validators==0.20.0
-msgram-core==1.4.5
-msgram-parser==1.1.3
+validators==0.33.0
+msgram-core~=1.4.9
+msgram-parser~=1.2.1
 anytree

sonar-project.properties

@@ -1,4 +1,4 @@
-sonar.projectKey=fga-eps-mds_2023-2-MeasureSoftGram-CLI
+sonar.projectKey=fga-eps-mds_2024.1-MeasureSoftGram-CLI
 sonar.organization=fga-eps-mds-1
 
 sonar.python.version=3

src/cli/aggregate_metrics.py

@@ -24,7 +24,7 @@
 ]
 
 measures = {}
-measures["sonar"] = [
+measures["sonarqube"] = [
     "passed_tests",
     "test_builds",
     "test_errors",
@@ -37,22 +37,16 @@
 measures["github"] = ["team_throughput", "ci_feedback_time"]
 
 
-def should_process_sonar_metrics(config):
+def should_process_metrics(config):
     for characteristic in config.get("characteristics", []):
         for subcharacteristic in characteristic.get("subcharacteristics", []):
             for measure in subcharacteristic.get("measures", []):
-                if measure.get("key") in measures["sonar"]:
-                    return True
-    return False
-
-
-def should_process_github_metrics(config):
-    for characteristic in config.get("characteristics", []):
-        for subcharacteristic in characteristic.get("subcharacteristics", []):
-            for measure in subcharacteristic.get("measures", []):
-                if measure.get("key") in measures["github"]:
-                    return True
-    return False
+                if (
+                    measure.get("key") not in measures["sonarqube"]
+                    and measure.get("key") not in measures["github"]
+                ):
+                    return False
+    return True
 
 
 def read_msgram(file_path):
@@ -96,134 +90,58 @@ def save_metrics(file_name, metrics):
     print_info(f"> [blue] Metrics saved to: {output_file_path}\n")
 
 
-def process_sonar_metrics(folder_path, msgram_files, github_files):
+def process_metrics(folder_path, msgram_files):
     processed_files = []
 
     for file in msgram_files:
-        if file not in github_files:
-            print_info(f"> [blue] Processing {file}")
-            sonar_metrics_dict = read_msgram(os.path.join(folder_path, file))
+        print_info(f"> [blue] Processing {file}")
+        metrics_dict = read_msgram(os.path.join(folder_path, file))
 
-            if not sonar_metrics_dict:
-                print_error(f"> [red] Error to read sonar metrics in: {folder_path}\n")
-                return False
+        if not metrics_dict:
+            print_error(f"> [red] Error to read metrics in: {folder_path}\n")
+            return False
 
-            processed_files.append((file, sonar_metrics_dict))
+        processed_files.append((file, metrics_dict))
 
     return processed_files
 
 
-def process_github_metrics(folder_path, github_files, metrics):
-    if not github_files:
-        print_error(f"> [red] GitHub files not found in the directory: {folder_path}\n")
-        return False
-
-    print_info(f"> [blue] GitHub metrics found in: {folder_path}\n")
-
-    github_metrics_list = []
-
-    for github_file_name in github_files:
-        github_file_path = os.path.join(folder_path, github_file_name)
-        github_file_content = read_msgram(github_file_path)
-
-        if not github_file_content:
-            print_error(f"> [red] Error to read github metrics in: {github_file_path}\n")
-            continue
-
-        github_key = next(iter(github_file_content.keys() - metrics["sonar"]), "")
-
-        github_metrics = [
-            {
-                "metric": metric,
-                "value": next(
-                    (
-                        m["value"]
-                        for m in github_file_content[github_key]
-                        if m["metric"] == metric
-                    ),
-                    None,
-                ),
-            }
-            for metric in metrics["github"]
-        ]
-
-        github_metrics_list.append((github_file_name, github_metrics))
-
-    return github_metrics_list
-
-
-def find_common_part(sonar_filename, github_result):
-    sonar_filename_root, _ = os.path.splitext(sonar_filename)
-
-    sonar_parts = sonar_filename_root.split('-')
-    if len(sonar_parts) >= 7:
-        sonar_key = '-'.join(sonar_parts[:7])
-
-        for github_filename, github_metrics in github_result:
-            github_filename_root, _ = os.path.splitext(github_filename)
-
-            if sonar_key in github_filename_root:
-                return github_metrics
-
-    return False
-
-
-def aggregate_metrics(folder_path, config: json):
+def aggregate_metrics(input_format, folder_path, config: json):
     msgram_files = list_msgram_files(folder_path)
 
     if not msgram_files:
         print_error("> [red]Error: Can not read msgram files in provided directory")
         return False
 
     github_files = [file for file in msgram_files if file.startswith("github_")]
-
+    sonar_files = [file for file in msgram_files if file not in github_files]
     file_content = {}
 
-    sonar_result = []
-    github_result = []
+    result = []
 
     have_metrics = False
 
-    config_has_github = should_process_github_metrics(config)
-
-    if config_has_github:
-        github_result = process_github_metrics(
-            folder_path, github_files, metrics
+    if should_process_metrics(config):
+        result = process_metrics(
+            folder_path, github_files if input_format == "github" else sonar_files
         )
 
-        if not github_result:
+        if not result:
             print_error("> [red]Error: Unexpected result from process_github_metrics")
             return False
 
         have_metrics = True
-
-    if should_process_sonar_metrics(config):
-        sonar_result = process_sonar_metrics(folder_path, msgram_files, github_files)
-
-        if not sonar_result:
-            print_error("> [red]Error: Unexpected result from process_sonar_metrics")
-            return False
-
-        have_metrics = True
+    else:
+        print_error("> [red]Error: Unexpected measures from should_process_metrics")
+        return False
 
     if not have_metrics:
-        print_error("> [red]Error: No metrics where found in the .msgram files")
+        print_error(
+            f"> [red]Error: No metrics where found in the .msgram files from the type: {input_format}"
+        )
         return False
 
-    for sonar_filename, file_content in sonar_result:
-        github_metrics = find_common_part(sonar_filename, github_result)
-
-        if github_metrics:
-            file_content["github_metrics"] = github_metrics
-        elif config_has_github:
-            print_error(
-                f"> [red]Error: The configuration provided by the user requires github metrics\n"
-                f"  but there was not found github metrics associated with the file:\n"
-                f"  {sonar_filename}"
-            )
-
-            return False
-
-        save_metrics(os.path.join(folder_path, sonar_filename), file_content)
+    for filename, file_content in result:
+        save_metrics(os.path.join(folder_path, filename), file_content)
 
     return True

src/cli/commands/__init__.py

@@ -1,3 +1,4 @@
 from src.cli.commands.cmd_init import command_init
 from src.cli.commands.cmd_extract import command_extract
 from src.cli.commands.cmd_calculate import command_calculate
+from src.cli.commands.cmd_norm_diff import command_norm_diff