fix(rest): correct response when fetching workflow logs by steps (#660)

Fixes unintentional code indentation that happened in #651 and that was
not returning proper endpoint response when fetching workflow logs by
steps. Adds a test case to cover this situation.

Closes #659

Author: CameronMcClymont

reana_workflow_controller/rest/workflows_status.py

@@ -150,6 +150,7 @@ def get_workflow_logs(workflow_id_or_name, paginate=None, **kwargs):  # noqa
         steps = None
         if request.is_json:
             steps = request.json
+
         if steps:
             workflow_logs = {
                 "workflow_logs": None,
@@ -172,30 +173,29 @@ def get_workflow_logs(workflow_id_or_name, paginate=None, **kwargs):  # noqa
             workflow_logs = {
                 "workflow_logs": logs or workflow.logs,
                 "job_logs": build_workflow_logs(workflow, paginate=paginate),
-                "service_logs": {},
+                "service_logs": {
+                    s.name: sorted(
+                        [log.log for log in s.logs],
+                        key=lambda x: x["component"]
+                        != "scheduler",  # scheduler logs first
+                    )
+                    for s in workflow.services
+                },
                 "engine_specific": workflow.engine_specific,
             }
 
-            workflow_logs["service_logs"] = {
-                s.name: sorted(
-                    [log.log for log in s.logs],
-                    key=lambda x: x["component"] != "scheduler",  # scheduler logs first
-                )
-                for s in workflow.services
-            }
-
-            return (
-                jsonify(
-                    {
-                        "workflow_id": workflow.id_,
-                        "workflow_name": get_workflow_name(workflow),
-                        "logs": json.dumps(workflow_logs),
-                        "user": user_uuid,
-                        "live_logs_enabled": REANA_OPENSEARCH_ENABLED,
-                    }
-                ),
-                200,
-            )
+        return (
+            jsonify(
+                {
+                    "workflow_id": workflow.id_,
+                    "workflow_name": get_workflow_name(workflow),
+                    "logs": json.dumps(workflow_logs),
+                    "user": user_uuid,
+                    "live_logs_enabled": REANA_OPENSEARCH_ENABLED,
+                }
+            ),
+            200,
+        )
 
     except ValueError:
         return (

tests/test_views.py

@@ -1240,7 +1240,85 @@ def test_get_created_workflow_logs(
                 ),
             }
             assert response_data == expected_data
-            mock_method.call_count == 2
+            assert mock_method.call_count == 2
+
+
+def test_get_created_workflow_logs_by_steps(
+    app,
+    user0,
+    cwl_workflow_with_name,
+    tmp_shared_volume_path,
+    session,
+):
+    """Test get workflow logs, filtering by steps."""
+    with app.test_client() as client:
+        # Create the workflow
+        res = client.post(
+            url_for("workflows.create_workflow"),
+            query_string={
+                "user": user0.id_,
+                "workspace_root_path": tmp_shared_volume_path,
+            },
+            content_type="application/json",
+            data=json.dumps(cwl_workflow_with_name),
+        )
+
+        # Get the generated workflow UUID
+        response_data = json.loads(res.get_data(as_text=True))
+        workflow_uuid = response_data.get("workflow_id")
+        workflow_name = response_data.get("workflow_name")
+
+        # Create a job for the workflow
+        workflow_job = Job(
+            id_=uuid.UUID("9a22c3a4-6d72-4812-93e7-7e0efdeb985d"),
+            workflow_uuid=workflow_uuid,
+        )
+        workflow_job.status = "running"
+        workflow_job.logs = "test job logs"
+        workflow_job.job_name = "gendata"
+        session.add(workflow_job)
+        session.commit()
+
+        # Call the API to fetch the workflow logs, filtering by steps
+        res = client.get(
+            url_for("statuses.get_workflow_logs", workflow_id_or_name=workflow_uuid),
+            query_string={"user": user0.id_},
+            content_type="application/json",
+            data=json.dumps(["gendata", "fitdata"]),
+        )
+
+        # Expect a successful response
+        assert res.status_code == 200
+
+        # Check the response data is as expected
+        response_data = json.loads(res.get_data(as_text=True))
+        expected_data = {
+            "workflow_id": workflow_uuid,
+            "workflow_name": workflow_name,
+            "user": str(user0.id_),
+            "live_logs_enabled": False,
+            "logs": json.dumps(
+                {
+                    "workflow_logs": None,
+                    "job_logs": {
+                        str(workflow_job.id_): {
+                            "workflow_uuid": str(workflow_job.workflow_uuid),
+                            "job_name": workflow_job.job_name,
+                            "compute_backend": "",
+                            "backend_job_id": "",
+                            "docker_img": "",
+                            "cmd": "",
+                            "status": workflow_job.status.name,
+                            "logs": "test job logs",
+                            "started_at": None,
+                            "finished_at": None,
+                        }
+                    },
+                    "engine_specific": None,
+                }
+            ),
+        }
+        assert response_data == expected_data
 
 
 def test_get_created_workflow_opensearch_disabled(