chore: rename commands to a verb_nouns format

Author: AcquaDiGiorgio

src/dirac_cwl/commands/__init__.py

@@ -1,20 +1,20 @@
 """Command classes for workflow pre/post-processing operations."""
 
 from .analyze_xml_summary import AnalyseXmlSummary
-from .bookkeeping_report import BookkeepingReport
 from .core import PostProcessCommand, PreProcessCommand
-from .failover_request import FailoverRequest
+from .create_failover_request import CreateFailoverRequest
+from .register_accounting_report import RegisterAccountingReport
+from .report_bookkeeping import ReportBookkeeping
 from .upload_log_file import UploadLogFile
 from .upload_output_data import UploadOutputData
-from .workflow_accounting import WorkflowAccounting
 
 __all__ = [
     "AnalyseXmlSummary",
     "PreProcessCommand",
     "PostProcessCommand",
     "UploadLogFile",
-    "BookkeepingReport",
-    "FailoverRequest",
+    "ReportBookkeeping",
+    "CreateFailoverRequest",
     "UploadOutputData",
-    "WorkflowAccounting",
+    "RegisterAccountingReport",
 ]

…c/dirac_cwl/commands/failover_request.py …_cwl/commands/create_failover_request.pysrc/dirac_cwl/commands/failover_request.py renamed to src/dirac_cwl/commands/create_failover_request.py src/dirac_cwl/commands/failover_request.py renamed to src/dirac_cwl/commands/create_failover_request.py

@@ -20,7 +20,7 @@
 logger = logging.getLogger(__name__)
 
 
-class FailoverRequest(PostProcessCommand):
+class CreateFailoverRequest(PostProcessCommand):
     """Commits the status of the files in the file report.
 
     The status will be "Processed" if everything ended properly or "Unused" if it did not.

…irac_cwl/commands/workflow_accounting.py …l/commands/register_accounting_report.pysrc/dirac_cwl/commands/workflow_accounting.py renamed to src/dirac_cwl/commands/register_accounting_report.py src/dirac_cwl/commands/workflow_accounting.py renamed to src/dirac_cwl/commands/register_accounting_report.py

@@ -22,7 +22,7 @@
 logger = logging.getLogger(__name__)
 
 
-class WorkflowAccounting(PostProcessCommand):
+class RegisterAccountingReport(PostProcessCommand):
     """Prepares and sends accounting information to the DIRAC Accounting system."""
 
     def _execute(self, job_path: os.PathLike[str], workflow_commons: WorkflowCommons, **kwargs):

…dirac_cwl/commands/bookkeeping_report.py …dirac_cwl/commands/report_bookkeeping.pysrc/dirac_cwl/commands/bookkeeping_report.py renamed to src/dirac_cwl/commands/report_bookkeeping.py src/dirac_cwl/commands/bookkeeping_report.py renamed to src/dirac_cwl/commands/report_bookkeeping.py

@@ -26,7 +26,7 @@
 logger = logging.getLogger(__name__)
 
 
-class BookkeepingReport(PostProcessCommand):
+class ReportBookkeeping(PostProcessCommand):
     """Generates a bookkeeping report file based on the XMLSummary and the pool XML catalog."""
 
     def _execute(self, job_path: os.PathLike[str], workflow_commons: WorkflowCommons, **kwargs):

test/test_command_bookkeeping_report.py

@@ -1,4 +1,4 @@
-"""Test for the BookkeepingReport command class."""
+"""Test for the ReportBookkeeping command class."""
 
 import time
 import xml.etree.ElementTree as ET
@@ -11,7 +11,7 @@
 from LHCbDIRAC.Core.Utilities.XMLSummaries import XMLSummary
 from pytest_mock import MockerFixture
 
-from dirac_cwl.commands import BookkeepingReport
+from dirac_cwl.commands import ReportBookkeeping
 from dirac_cwl.commands.workflow_commons import StepStatus, WorkflowCommons
 
 
@@ -41,31 +41,31 @@ def get_output_file_details(output_file):
     return details
 
 
-class TestBookkeepingReport:
-    """Collection of tests for the BookkeepingReport command."""
+class TestReportBookkeeping:
+    """Collection of tests for the ReportBookkeeping command."""
 
     number_of_processors = 1
 
     @pytest.fixture
-    def bk_report(self, mocker: MockerFixture, job_path):
-        """BookkeepingReport mocked command.
+    def report_bk(self, mocker: MockerFixture, job_path):
+        """ReportBookkeeping mocked command.
 
         Cleans created files after execution.
         """
-        mock_get_n_procs = mocker.patch("dirac_cwl.commands.bookkeeping_report.getNumberOfProcessorsToUse")
+        mock_get_n_procs = mocker.patch("dirac_cwl.commands.report_bookkeeping.getNumberOfProcessorsToUse")
         mock_get_n_procs.return_value = self.number_of_processors
 
-        yield BookkeepingReport()
+        yield ReportBookkeeping()
 
         Path(job_path).joinpath("00209455_00001537_1").unlink(missing_ok=True)
         Path(job_path).joinpath("00209455_00001537_1.sim").unlink(missing_ok=True)
         Path(job_path).joinpath("application.log").unlink(missing_ok=True)
         Path(job_path).joinpath("workflow_commons.json").unlink(missing_ok=True)
 
-    def test_bkreport_prod_mcsimulation_success(
-        self, bk_report, job_path, wf_commons, bookkeeping_file, xml_summary_file
+    def test_report_bk_prod_mcsimulation_success(
+        self, report_bk, job_path, wf_commons, bookkeeping_file, xml_summary_file
     ):
-        """Test successful execution of BookkeepingReport module."""
+        """Test successful execution of ReportBookkeeping module."""
         wf_commons["steps"][0]["application_name"] = "Gauss"
         wf_commons["job_type"] = "MCSimulation"
 
@@ -124,7 +124,7 @@ def test_bkreport_prod_mcsimulation_success(
 
         WorkflowCommons(**wf_commons).save(job_path)
 
-        bk_report.execute(job_path)
+        report_bk.execute(job_path)
 
         updated_wf_commons = WorkflowCommons.load(job_path)
 
@@ -187,17 +187,17 @@ def test_bkreport_prod_mcsimulation_success(
 
         assert len(output_files) == 1
 
-    def test_bkreport_prod_mcsimulation_noinputoutput_success(
-        self, bk_report, job_path, wf_commons, bookkeeping_file, xml_summary_file
+    def test_report_bk_prod_mcsimulation_noinputoutput_success(
+        self, report_bk, job_path, wf_commons, bookkeeping_file, xml_summary_file
     ):
-        """Test successful execution of BookkeepingReport module.
+        """Test successful execution of ReportBookkeeping module.
 
         * No input files because wf_commons["stepInputData is empty
         * No output files because wf_commons["stepOutputData is empty
         * No pool xml catalog
         * Simulation conditions because the application used is Gauss
         """
-        # Mock the BookkeepingReport module
+        # Mock the ReportBookkeeping module
         wf_commons["steps"][0]["application_name"] = "Gauss"
         wf_commons["job_type"] = "MCSimulation"
 
@@ -251,7 +251,7 @@ def test_bkreport_prod_mcsimulation_noinputoutput_success(
 
         WorkflowCommons(**wf_commons).save(job_path)
 
-        bk_report.execute(job_path)
+        report_bk.execute(job_path)
 
         updated_wf_commons = WorkflowCommons.load(job_path)
 
@@ -305,10 +305,10 @@ def test_bkreport_prod_mcsimulation_noinputoutput_success(
         output_file = root.find("OutputFile")
         assert output_file is None, "OutputFile element should not be present."
 
-    def test_bk_report_prod_mcreconstruction_success(
-        self, bk_report, job_path, wf_commons, bookkeeping_file, xml_summary_file
+    def test_report_bk_prod_mcreconstruction_success(
+        self, report_bk, job_path, wf_commons, bookkeeping_file, xml_summary_file
     ):
-        """Test successful execution of BookkeepingReport module."""
+        """Test successful execution of ReportBookkeeping module."""
         wf_commons["steps"][0]["application_name"] = "Boole"
         wf_commons["job_type"] = "MCReconstruction"
 
@@ -359,7 +359,7 @@ def test_bk_report_prod_mcreconstruction_success(
 
         WorkflowCommons(**wf_commons).save(job_path)
 
-        bk_report.execute(job_path)
+        report_bk.execute(job_path)
 
         updated_wf_commons = WorkflowCommons.load(job_path)
 
@@ -427,7 +427,7 @@ def test_bk_report_prod_mcreconstruction_success(
         simulation_condition = root.find("SimulationCondition")
         assert simulation_condition is None, "SimulationCondition element should not be present."
 
-    def test_bkreport_previousError_success(self, bk_report, job_path, wf_commons, bookkeeping_file):
+    def test_report_bk_previousError_success(self, report_bk, job_path, wf_commons, bookkeeping_file):
         """Test previous command failure."""
         wf_commons["steps"][0]["application_name"] = "Gauss"
         wf_commons["steps"][0]["application_version"] = wf_commons["config_version"]
@@ -436,6 +436,6 @@ def test_bkreport_previousError_success(self, bk_report, job_path, wf_commons, b
 
         WorkflowCommons(**wf_commons).save(job_path)
 
-        bk_report.execute(job_path)
+        report_bk.execute(job_path)
 
         assert not Path(bookkeeping_file).exists()

test/test_command_failover_request.py

@@ -11,11 +11,11 @@
 from DIRACCommon.Core.Utilities.ReturnValues import S_ERROR, S_OK
 from pytest_mock import MockerFixture
 
-from dirac_cwl.commands import FailoverRequest
+from dirac_cwl.commands import CreateFailoverRequest
 from dirac_cwl.commands.workflow_commons import WorkflowCommons
 
 
-class TestFailoverRequest:
+class TestCreateFailoverRequest:
     """Collection of tests for the FailoverRequest command."""
 
     @pytest.fixture
@@ -28,7 +28,7 @@ def failover_request(self, mocker: MockerFixture, wf_commons, job_path):
             "DIRAC.RequestManagementSystem.private.RequestValidator.RequestValidator.validate", return_value=S_OK()
         )
 
-        command = FailoverRequest()
+        command = CreateFailoverRequest()
         command.request = Request()
         command.file_report = FileReport()
         command.failover_transfer = FailoverTransfer(command.request)
@@ -41,7 +41,9 @@ def failover_request(self, mocker: MockerFixture, wf_commons, job_path):
 
         Path(job_path).joinpath("workflow_commons.json").unlink(missing_ok=True)
 
-    def test_failoverRequest_success(self, mocker: MockerFixture, failover_request, job_path, wf_commons, request_file):
+    def test_failover_request_success(
+        self, mocker: MockerFixture, failover_request, job_path, wf_commons, request_file
+    ):
         """Test successful execution of FailoverRequest module."""
         problematic_files = [
             "/lhcb/data/2010/EW.DST/00008380/0000/00008380_00000287_1.ew.dst",
@@ -86,7 +88,7 @@ def test_failoverRequest_success(self, mocker: MockerFixture, failover_request,
         # Make sure the request json does not exists
         assert not Path(request_file).exists()
 
-    def test_failoverRequest_commitFailure1(
+    def test_failover_request_commitFailure1(
         self, mocker: MockerFixture, failover_request, job_path, wf_commons, request_file
     ):
         """Test execution of FailoverRequest module when the fileReport.commit() fails.
@@ -139,7 +141,7 @@ def test_failoverRequest_commitFailure1(
         # Make sure the request json does not exists
         assert not Path(request_file).exists()
 
-    def test_failoverRequest_commitFailure2(
+    def test_failover_request_commitFailure2(
         self, mocker: MockerFixture, failover_request, job_path, wf_commons, request_file
     ):
         """Test execution of FailoverRequest module when the fileReport.commit() fails.
@@ -196,7 +198,7 @@ def test_failoverRequest_commitFailure2(
         # Make sure the request json does not exists
         assert Path(request_file).exists()
 
-    def test_failoverRequest_previousError_fail(
+    def test_failover_request_previousError_fail(
         self, mocker: MockerFixture, failover_request, job_path, wf_commons, request_file
     ):
         """Test FailoverRequest with an intentional failure."""

test/test_command_workflow_accounting.py

@@ -1,4 +1,4 @@
-"""Test for the WorkflowAccounting command class."""
+"""Test for the RegisterAccountingReport command class."""
 
 from pathlib import Path
 from textwrap import dedent
@@ -7,17 +7,17 @@
 from DIRAC.AccountingSystem.Client.DataStoreClient import DataStoreClient
 from pytest_mock import MockerFixture
 
-from dirac_cwl.commands import WorkflowAccounting
+from dirac_cwl.commands import RegisterAccountingReport
 from dirac_cwl.commands.workflow_commons import StepStatus, WorkflowCommons
 
 
-class TestWorkflowAccounting:
-    """Collection of tests for the WorkflowAccounting command."""
+class TestRegisterAccountingReport:
+    """Collection of tests for the RegisterAccountingReport command."""
 
     @pytest.fixture
     def accounting(self, mocker: MockerFixture, job_path):
-        """Fixture for WorkflowAccounting module."""
-        command = WorkflowAccounting()
+        """Fixture for RegisterAccountingReport module."""
+        command = RegisterAccountingReport()
 
         command.dsc = DataStoreClient()
         mocker.patch.object(command.dsc, "addRegister")
@@ -28,7 +28,7 @@ def accounting(self, mocker: MockerFixture, job_path):
 
     # Test Scenarios
     def test_accounting_success(self, mocker: MockerFixture, job_path, accounting, wf_commons, xml_summary_file):
-        """Test successful execution of WorkflowAccounting module."""
+        """Test successful execution of RegisterAccountingReport module."""
         wf_commons["steps"][0]["application_name"] = "Gauss"
         xml_content = dedent("""<?xml version="1.0" encoding="UTF-8"?>
             <summary version="1.0" xsi:noNamespaceSchemaLocation="$XMLSUMMARYBASEROOT/xml/XMLSummary.xsd"
@@ -69,7 +69,7 @@ def test_accounting_success(self, mocker: MockerFixture, job_path, accounting, w
     def test_accounting_noApplicationName_fail(
         self, mocker: MockerFixture, job_path, accounting, wf_commons, xml_summary_file
     ):
-        """Test WorkflowAccounting when there is no application name in step commons."""
+        """Test RegisterAccountingReport when there is no application name in step commons."""
         xml_content = dedent("""<?xml version="1.0" encoding="UTF-8"?>
             <summary version="1.0" xsi:noNamespaceSchemaLocation="$XMLSUMMARYBASEROOT/xml/XMLSummary.xsd"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
@@ -107,7 +107,7 @@ def test_accounting_noApplicationName_fail(
     def test_accounting_incompleteData_success(
         self, mocker: MockerFixture, job_path, accounting, wf_commons, xml_summary_file
     ):
-        """Test successful execution of WorkflowAccounting module."""
+        """Test successful execution of RegisterAccountingReport module."""
         xml_content = dedent("""<?xml version="1.0" encoding="UTF-8"?>
             <summary version="1.0" xsi:noNamespaceSchemaLocation="$XMLSUMMARYBASEROOT/xml/XMLSummary.xsd"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
@@ -145,7 +145,7 @@ def test_accounting_incompleteData_success(
     def test_accounting_previousError_fail(
         self, mocker: MockerFixture, job_path, accounting, wf_commons, xml_summary_file
     ):
-        """Test WorkflowAccounting with an intentional failure."""
+        """Test RegisterAccountingReport with an intentional failure."""
         xml_content = dedent("""<?xml version="1.0" encoding="UTF-8"?>
             <summary version="1.0" xsi:noNamespaceSchemaLocation="$XMLSUMMARYBASEROOT/xml/XMLSummary.xsd"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">