msgram 3.2.2__tar.gz → 3.3.0__tar.gz

{msgram-3.2.2 → msgram-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msgram
-Version: 3.2.2
+Version: 3.3.0
 Summary: The msgram CLI is a command-line interface to use MeasureSoftGram software
 Author-email: MeasureSoftGram <measuresoftgram@gmail.com>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -684,7 +684,7 @@ Requires-Dist: setuptools~=72.1.0
 Requires-Dist: python-dotenv
 Requires-Dist: rich
 Requires-Dist: validators~=0.33.0
-Requires-Dist: msgram-core~=1.4.9
+Requires-Dist: msgram-core~=1.5.3
 Requires-Dist: msgram-parser~=1.2.1
 Requires-Dist: anytree
 Provides-Extra: dev

{msgram-3.2.2 → msgram-3.3.0}/msgram.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: msgram
-Version: 3.2.2
+Version: 3.3.0
 Summary: The msgram CLI is a command-line interface to use MeasureSoftGram software
 Author-email: MeasureSoftGram <measuresoftgram@gmail.com>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -684,7 +684,7 @@ Requires-Dist: setuptools~=72.1.0
 Requires-Dist: python-dotenv
 Requires-Dist: rich
 Requires-Dist: validators~=0.33.0
-Requires-Dist: msgram-core~=1.4.9
+Requires-Dist: msgram-core~=1.5.3
 Requires-Dist: msgram-parser~=1.2.1
 Requires-Dist: anytree
 Provides-Extra: dev

{msgram-3.2.2 → msgram-3.3.0}/msgram.egg-info/SOURCES.txt

@@ -28,6 +28,8 @@ src/cli/resources/__init__.py
 src/cli/resources/characteristic.py
 src/cli/resources/measure.py
 src/cli/resources/metrics.py
+src/cli/resources/perf_eff_measure.py
+src/cli/resources/perf_eff_parser.py
 src/cli/resources/subcharacteristic.py
 src/cli/resources/tsqmi.py
 src/config/__init__.py

{msgram-3.2.2 → msgram-3.3.0}/msgram.egg-info/requires.txt

@@ -8,7 +8,7 @@ setuptools~=72.1.0
 python-dotenv
 rich
 validators~=0.33.0
-msgram-core~=1.4.9
+msgram-core~=1.5.3
 msgram-parser~=1.2.1
 anytree
 

{msgram-3.2.2 → msgram-3.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "msgram"
-version = "3.2.2"
+version = "3.3.0"
 description = "The msgram CLI is a command-line interface to use MeasureSoftGram software"
 readme = "README.md"
 authors = [
@@ -32,7 +32,7 @@ dependencies = [
         "python-dotenv",
         "rich",
         "validators~=0.33.0",
-        "msgram-core~=1.4.9",
+        "msgram-core~=1.5.3",
         "msgram-parser~=1.2.1",
         "anytree"
     ]

{msgram-3.2.2 → msgram-3.3.0}/src/cli/commands/cmd_calculate.py

@@ -16,9 +16,9 @@ from src.cli.resources.measure import calculate_measures
 from src.cli.resources.tsqmi import calculate_tsqmi
 from src.cli.resources.subcharacteristic import calculate_subcharacteristics
 from src.cli.utils import print_error, print_info, print_panel, print_rule, print_table
-from src.cli.aggregate_metrics import aggregate_metrics
 from src.cli.exceptions import exceptions
 from src.config.settings import DEFAULT_CONFIG_PATH, FILE_CONFIG
+from src.cli.resources.perf_eff_measure import calculate_perf_eff_measures
 
 logger = logging.getLogger("msgram")
 
@@ -34,23 +34,33 @@ def read_config_file(config_path):
         exit(1)
 
 
-def calculate_metrics(input_format, extracted_path, config):
+# calculate_sonar
+# calculate_github
+
+
+def calculate_metrics(extracted_path, config):
     data_calculated = []
 
+    print(extracted_path)
     if not extracted_path.is_file():
-        if not aggregate_metrics(input_format, extracted_path, config):
-            print_error(
-                "> [red] Failed to aggregate metrics, calculate was not performed. \n"
-            )
-            return data_calculated, False
-
-        for file, file_name in read_multiple_files(
-            extracted_path, input_format, "metrics"
-        ):
-            if file_name.startswith("github_"):
-                file_name = file_name[len("github_") :]
-            result = calculate_all(file, file_name, config)
-            data_calculated.append(result)
+        # should not aggregate
+        # if not aggregate_metrics(input_format, extracted_path, config):
+        #    print_error(
+        #        "> [red] Failed to aggregate metrics, calculate was not performed. \n"
+        #    )
+        #    return data_calculated, False
+
+        for file, file_name in read_multiple_files(extracted_path, "metrics"):
+            print(file_name)
+            if file_name.startswith("perf-eff_"):
+                file_name = file_name[len("perf-eff_") :]
+                result = calculate_perf_eff_measures(file_name, file)
+                data_calculated.append(result)
+            else:
+                if file_name.startswith("github_"):
+                    file_name = file_name[len("github_") :]
+                result = calculate_all(file, file_name, config)
+                data_calculated.append(result)
 
         return data_calculated, True
     else:
@@ -59,7 +69,8 @@ def calculate_metrics(input_format, extracted_path, config):
             if extracted_path.name.startswith("github_"):
                 file_name = file_name[len("github_") :]
             result = calculate_all(open_json_file(extracted_path), file_name, config)
-            return result, True
+            data_calculated.append(result)
+            return data_calculated, True
         except exceptions.MeasureSoftGramCLIException as e:
             print_error(f"[red]Error calculating {extracted_path}: {e}\n")
             return data_calculated, False
@@ -68,7 +79,7 @@ def calculate_metrics(input_format, extracted_path, config):
 def command_calculate(args):
     try:
         output_format: str = args["output_format"]
-        input_format: str = args["input_format"]
+        # input_format: str = args["input_format"]
         config_path = args["config_path"]
         extracted_path = args["extracted_path"]
 
@@ -86,7 +97,7 @@ def command_calculate(args):
 
     print_info("\n> [blue] Reading extracted files:[/]")
 
-    data_calculated, success = calculate_metrics(input_format, extracted_path, config)
+    data_calculated, success = calculate_metrics(extracted_path, config)
 
     if success:
         print_info("\n[#A9A9A9]All calculations performed[/] successfully!")
@@ -96,8 +107,9 @@ def command_calculate(args):
 
     print_panel(
         title="Done",
-        menssage="> See our docs for more information: \n"
-        " https://github.com/fga-eps-mds/2022-2-MeasureSoftGram-CLI",
+        menssage="> See the publications for more information: \n"
+        "https://dl.acm.org/doi/10.1145/3239235.3267438 \n"
+        "https://dl.acm.org/doi/10.1145/3422392.3422450 \n",
     )
 
 
@@ -139,13 +151,13 @@ def calculate_all(json_data, file_name, config):
 def show_results(output_format, data_calculated, config_path):
 
     if output_format == "tabular":
-        show_tabulate(data_calculated)
+        show_tabulate(data_calculated[0])
 
     elif output_format == "raw":
-        print(data_calculated)
+        print(data_calculated[0])
 
     elif output_format == "tree":
-        show_tree(data_calculated, pre_config)
+        show_tree(data_calculated[0], pre_config)
 
     elif len(data_calculated) == 0:
         print_info(

{msgram-3.2.2 → msgram-3.3.0}/src/cli/commands/cmd_diff.py

@@ -15,6 +15,7 @@ from src.cli.utils import (
     print_info,
     print_panel,
     print_rule,
+    validate_json_values,
 )
 from src.cli.exceptions import exceptions
 from src.config.settings import DEFAULT_CONFIG_PATH
@@ -61,7 +62,7 @@ def read_calculated_file(extracted_calculation):
         exit(1)
 
 
-def calculate_diff(planned, calculated):
+def calculate_diff(planned, calculated, rp_path, rd_path):
     formated_result = []
 
     try:
@@ -73,7 +74,7 @@ def calculate_diff(planned, calculated):
                 )
 
             data_planned, data_calculated = extract_values(
-                planned, calculated_item["characteristics"]
+                planned, calculated_item["characteristics"], rp_path, rd_path
             )
 
             diff_calculated = diff(data_planned, data_calculated)
@@ -124,7 +125,9 @@ def command_diff(args):
 
     calculated = read_calculated_file(extracted_calculation)
 
-    diff_calculated, success = calculate_diff(planned, calculated)
+    diff_calculated, success = calculate_diff(
+        planned, calculated, config_path, extracted_calculation
+    )
 
     if success:
         print_info("\n[#A9A9A9]Diff calculation performed[/] successfully!")
@@ -136,8 +139,9 @@ def command_diff(args):
 
     print_panel(
         title="Done",
-        menssage="> See our docs for more information: \n"
-        " https://github.com/fga-eps-mds/2022-2-MeasureSoftGram-CLI",
+        menssage="> See the publications for more information: \n"
+        "https://dl.acm.org/doi/10.1145/3239235.3267438 \n"
+        "https://dl.acm.org/doi/10.1145/3422392.3422450 \n",
     )
 
 
@@ -208,7 +212,7 @@ def export_csv(data_calculated: list, file_path: Path = Path("DEFAULT_CONFIG_PAT
     print(f"Success: {file_path.name} exported as CSV")
 
 
-def extract_values(planned, calculated):
+def extract_values(planned, calculated, rp_path, rd_path):
     vector_calculated = []
     vector_planned = []
 
@@ -221,4 +225,7 @@ def extract_values(planned, calculated):
             vector_calculated.append(calculated[x]["value"])
             vector_planned.append(planned[x]["value"])
 
+    validate_json_values(vector_planned, rp_path)
+    validate_json_values(vector_calculated, rd_path)
+
     return vector_planned, vector_calculated

msgram-3.3.0/src/cli/commands/cmd_extract.py

@@ -0,0 +1,237 @@
+from datetime import datetime
+import json
+import logging
+import os
+import re
+import sys
+from time import perf_counter
+from pathlib import Path
+
+from rich import print
+from rich.console import Console
+from genericparser import GenericParser
+
+from src.cli.jsonReader import folder_reader
+from src.cli.utils import (
+    make_progress_bar,
+    print_info,
+    print_panel,
+    print_rule,
+    print_warn,
+    is_valid_date_range,
+)
+from src.cli.resources.perf_eff_parser import parse_performance_efficiency_data
+
+logger = logging.getLogger("msgram")
+
+
+def get_infos_from_name(filename: str) -> str:
+    """
+    filename: str = fga-eps-mds-2022-1-MeasureSoftGram-Service-09-11-2022-16-11-42-develop.json
+    """
+    file_date = re.search(r"\d{1,2}-\d{1,2}-\d{4}-\d{1,2}-\d{1,2}", filename)
+
+    if not file_date:
+        message = (
+            "Could not extract creation date from file. Was the file name "
+            "to contain a date in the format dd-mm-yyyy-hh-mm"
+        )
+        print_warn(message)
+        print_warn(f"filename: {filename}")
+        sys.exit(1)
+
+    file_name = filename.split(".")[0]
+
+    return f"{file_name}-extracted.metrics"
+
+
+def parse_input_quotes(user_input):
+    # Aspas para normalizar
+    quotes = "“‘«”’»"
+
+    if user_input:
+        # Remove aspas no início
+        user_input = user_input[1:] if user_input[0] in quotes else user_input
+
+        # Remove aspas no final
+        user_input = user_input[:-1] if user_input[-1] in quotes else user_input
+
+    return user_input
+
+
+def extract_github(
+    extracted_path: Path,
+    gh_repository: str,
+    gh_date_range: str,
+    gh_label: str,
+    gh_workflows: str,
+    parser: GenericParser,
+):
+    input_origin = "github"
+    if gh_date_range is not None and not is_valid_date_range(gh_date_range):
+        logger.error(
+            "Error: Range of dates for filter must be in format 'dd/mm/yyyy-dd/mm/yyyy'"
+        )
+        print_warn(
+            "Error: Range of dates for filter must be in format 'dd/mm/yyyy-dd/mm/yyyy'"
+        )
+        sys.exit(1)
+    filters = {
+        "labels": gh_label if gh_label else "US,User Story,User Stories",
+        "workflows": gh_workflows.split(",") if gh_workflows else "build",
+        "dates": gh_date_range if gh_date_range else None,
+    }
+    print_info(f"\n> Extract and save metrics [[blue ]{input_origin}[/]]:")
+    result = parser.parse(
+        input_value=gh_repository, type_input=input_origin, filters=filters
+    )
+    repository_name = gh_repository.replace("/", "-")
+    save_file_with_results(
+        extracted_path,
+        gh_repository,
+        name=f"github_{repository_name}-{datetime.now().strftime('%d-%m-%Y-%H-%M-%S')}-extracted.metrics",
+        result=result,
+    )
+
+
+def extract_sonar(extracted_path: Path, sonar_path: Path, parser: GenericParser):
+    time_init = perf_counter()
+    input_origin = "sonarqube"
+
+    logger.debug(f"input_origin: {input_origin}")
+    logger.debug(f"data_path: {sonar_path}")
+    logger.debug(f"extracted_path: {extracted_path}")
+
+    files = list(sonar_path.glob("*.json"))
+
+    if not files:
+        print_warn(f"No JSON files found in the specified data_path: {sonar_path}\n")
+        sys.exit(1)
+
+    valid_files = len(files)
+
+    print_info(f"\n> Extract and save metrics [[blue ]{input_origin}[/]]:")
+    with make_progress_bar() as progress_bar:
+        task_request = progress_bar.add_task(
+            "[#A9A9A9]Extracting files: ", total=len(files)
+        )
+        progress_bar.advance(task_request)
+
+        for component, filename, files_error in folder_reader(sonar_path, "json"):
+            if files_error:
+                progress_bar.update(task_request, advance=files_error)
+                valid_files = valid_files - files_error
+
+            name = get_infos_from_name(filename)
+            result = parser.parse(input_value=component, type_input=input_origin)
+
+            save_file_with_results(extracted_path, filename, name, result)
+
+            progress_bar.advance(task_request)
+
+        time_extract = perf_counter() - time_init
+        print_info(
+            f"\n\nMetrics successfully extracted [[blue bold]{valid_files}/{len(files)} "
+            f"files - {time_extract:0.2f} seconds[/]]!"
+        )
+
+
+def extract_perf_eff():
+    pass
+
+
+def command_extract(args):
+    try:
+        extracted_path = args["extracted_path"]
+        sonar_path = args.get("sonar_path", None)
+        gh_repository = args.get("gh_repository", None)
+        gh_label = args.get("gh_label", None)
+        gh_workflows = args.get("gh_workflows", None)
+        gh_date_range = args.get("gh_date_range", None)
+        pe_release1 = args.get("pe_release_1", None)
+        pe_release2 = args.get("pe_release_2", None)
+        pe_repository_name = args.get("pe_repository_name", None)
+
+    except Exception as e:
+        logger.error(f"KeyError: args[{e}] - non-existent parameters")
+        print_warn(f"KeyError: args[{e}] - non-existent parameters")
+        exit(1)
+
+    pe_params = (
+        (pe_release1 is not None)
+        + (pe_release2 is not None)
+        + (pe_repository_name is not None)
+    )
+    if pe_params > 0 and pe_params < 3:
+        print_warn(
+            "Error: Some pe_ parameters for extracting the performance efficiency data are missing"
+        )
+        exit()
+
+    # First check if sonar_path and gh_repository are none
+    if (sonar_path is None) and (gh_repository is None) and (pe_params == 0):
+        logger.error(
+            "It is necessary to pass sonar_path, github_repository or the pe_ parameters"
+        )
+        print_warn(
+            "It is necessary to pass sonar_path, github_repository or the pe_ parameters"
+        )
+        sys.exit(1)
+
+    console = Console()
+    console.clear()
+    print_rule("Extract metrics")
+    parser = GenericParser()
+
+    if not os.path.isdir(extracted_path):
+        logger.error(
+            f'FileNotFoundError: extract directory "{extracted_path}" does not exists'
+        )
+        print_warn(
+            f"FileNotFoundError: extract directory[blue]'{extracted_path}'[/]does not exists"
+        )
+        sys.exit(1)
+
+    # Github repository is defined so we should generate github metrics
+    if gh_repository:
+        extract_github(
+            extracted_path, gh_repository, gh_date_range, gh_label, gh_workflows, parser
+        )
+    elif gh_label or gh_workflows or gh_date_range:
+        logger.error(
+            "Error: gh_repository must be specified in order to use gh_ parameters"
+        )
+        print_warn(
+            "Error: gh_repository must be specified in order to use gh_ parameters"
+        )
+        sys.exit(1)
+
+    if pe_params == 3:
+        input_origin = "performance-efficiency"
+        print_info(f"\n> Extract and save metrics [[blue ]{input_origin}[/]]:")
+        # All pe_params are set, so we should extract the performance efficiency data
+        parsed_data = parse_performance_efficiency_data(
+            pe_release1, pe_release2, pe_repository_name
+        )
+        save_file_with_results(
+            extracted_path,
+            pe_repository_name,
+            name=f"perf-eff_{pe_repository_name}-{datetime.now().strftime('%d-%m-%Y-%H-%M-%S')}-extracted.metrics",
+            result=parsed_data,
+        )
+
+    # Sonargube path is defined so we should generate sonar metrics
+    if sonar_path:
+        extract_sonar(extracted_path, sonar_path, parser)
+
+    print_panel(
+        "> Run [#008080]msgram calculate all -ep 'extracted_path' -cp 'extracted_path' -o 'input_origin'"
+    )
+
+
+def save_file_with_results(extracted_path, filename, name, result):
+    print(f"[dark_green]Reading:[/] [black]{filename}[/]")
+    print(f"[dark_green]Save   :[/] [black]{name}[/]\n")
+
+    with open(f"{extracted_path}/{name}", "w") as f:
+        f.write(json.dumps(result, indent=2))

{msgram-3.2.2 → msgram-3.3.0}/src/cli/commands/cmd_list.py

@@ -62,6 +62,7 @@ def print_json_tree(data):
                     metrics = measure_to_metric.get(
                         measure_key, []
                     )  # Get associated metrics
+                    min_max = ""
                     for metric in metrics:
                         result.append(
                             f"[#FFFFFF]{indent}{indent}│  └─[#00FF00]{metric}"

{msgram-3.2.2 → msgram-3.3.0}/src/cli/commands/cmd_norm_diff.py

@@ -1,7 +1,12 @@
 import logging
 from core.transformations import norm_diff
 from src.cli.jsonReader import open_json_file
-from src.cli.utils import print_error, print_info, print_rule
+from src.cli.utils import (
+    print_error,
+    print_info,
+    print_rule,
+    validate_json_values,
+)
 from src.cli.exceptions import exceptions
 import numpy as np
 
@@ -51,6 +56,7 @@ def command_norm_diff(args):
         exit(1)
 
     planned_data = read_planned_file(rp_path, sort_key="key")
+
     calculated_data = read_calculated_file(rd_path)
 
     planned_vector, calculated_vector = extract_values(
@@ -98,21 +104,8 @@ def extract_values(planned_data, calculated_data, rp_path, rd_path):
         planned_values = [planned_dict[key] for key in planned_keys]
         calculated_values = [calculated_dict[key] for key in planned_keys]
 
-        for value in planned_values:
-            if value > 1 or value < 0:
-                print_error(
-                    f"[red]The values informed in the .json file {rp_path} must be between 0 and 1.\n"
-                )
-                print_rule()
-                exit(1)
-
-        for value in calculated_values:
-            if value > 1 or value < 0:
-                print_error(
-                    f"[red]The values informed in the .json file {rd_path} must be between 0 and 1.\n"
-                )
-                print_rule()
-                exit(1)
+        validate_json_values(planned_values, rp_path)
+        validate_json_values(calculated_values, rd_path)
 
         return (np.array(planned_values), np.array(calculated_values))
     except exceptions.MeasureSoftGramCLIException as e:

{msgram-3.2.2 → msgram-3.3.0}/src/cli/jsonReader/jsonReader.py

@@ -29,13 +29,14 @@ def file_reader(path_file):
     return components
 
 
-def read_multiple_files(directory: Path, format: str, pattern: str):
-    if format == "github":
-        glob_pattern = f"github_*.{pattern}"
-    elif format == "sonarqube":
-        glob_pattern = f"[!github_]*.{pattern}"
-    else:
-        glob_pattern = f"*.{pattern}"
+def read_multiple_files(directory: Path, pattern: str):
+    # if format == "github":
+    #     glob_pattern = f"github_*.{pattern}"
+    # elif format == "sonarqube":
+    #     glob_pattern = f"[!github_]*.{pattern}"
+    # else:
+    #     glob_pattern = f"*.{pattern}"
+    glob_pattern = f"*.{pattern}"
 
     for path_file in directory.glob(glob_pattern):
         try: