Artifacts on Runs

backend/ibutsu_server/controllers/artifact_controller.py

@@ -61,7 +61,7 @@ def get_artifact(id_):
     return artifact.to_dict()
 
 
-def get_artifact_list(result_id=None, page_size=25, page=1):
+def get_artifact_list(result_id=None, run_id=None, page_size=25, page=1):
     """Get a list of artifact files for result
 
     :param id: ID of test result
@@ -72,6 +72,8 @@ def get_artifact_list(result_id=None, page_size=25, page=1):
     query = Artifact.query
     if result_id:
         query = query.filter(Artifact.result_id == result_id)
+    if run_id:
+        query = query.filter(Artifact.run_id == run_id)
     total_items = query.count()
     offset = (page * page_size) - page_size
     total_pages = (total_items // page_size) + (1 if total_items % page_size > 0 else 0)
@@ -92,6 +94,8 @@ def upload_artifact(body):
 
     :param result_id: ID of result to attach artifact to
     :type result_id: str
+    :param run_id: ID of run to attach artifact to
+    :type run_id: str
     :param filename: filename for storage
     :type filename: string
     :param file: file to upload
@@ -102,11 +106,17 @@ def upload_artifact(body):
     :rtype: tuple
     """
     result_id = body.get("result_id")
+    run_id = body.get("run_id")
     filename = body.get("filename")
     additional_metadata = body.get("additional_metadata", {})
     file_ = connexion.request.files["file"]
     content_type = magic.from_buffer(file_.read())
-    data = {"contentType": content_type, "resultId": result_id, "filename": filename}
+    data = {
+        "contentType": content_type,
+        "resultId": result_id,
+        "runId": run_id,
+        "filename": filename,
+    }
     if additional_metadata:
         if isinstance(additional_metadata, str):
             try:
@@ -118,13 +128,23 @@ def upload_artifact(body):
         data["additionalMetadata"] = additional_metadata
     # Reset the file pointer
     file_.seek(0)
-    artifact = Artifact(
-        filename=filename,
-        result_id=data["resultId"],
-        content=file_.read(),
-        upload_date=datetime.utcnow(),
-        data=additional_metadata,
-    )
+    if data.get("runId"):
+        artifact = Artifact(
+            filename=filename,
+            result_id=data["runId"],
+            content=file_.read(),
+            upload_date=datetime.utcnow(),
+            data=additional_metadata,
+        )
+    else:
+        artifact = Artifact(
+            filename=filename,
+            result_id=data["resultId"],
+            content=file_.read(),
+            upload_date=datetime.utcnow(),
+            data=additional_metadata,
+        )
+
     session.add(artifact)
     session.commit()
     return artifact.to_dict(), 201

backend/ibutsu_server/db/models.py

@@ -78,7 +78,8 @@ def to_dict(self):
 
 class Artifact(Model, FileMixin):
     __tablename__ = "artifacts"
-    result_id = Column(PortableUUID(), ForeignKey("results.id"), nullable=False, index=True)
+    result_id = Column(PortableUUID(), ForeignKey("results.id"), index=True)
+    run_id = Column(PortableUUID(), ForeignKey("runs.id"), index=True)
     filename = Column(Text, index=True)
     data = Column(mutable_json_type(dbtype=PortableJSON(), nested=True))
     upload_date = Column(DateTime, default=datetime.utcnow, index=True)
@@ -169,6 +170,7 @@ class Result(Model, ModelMixin):
 
 class Run(Model, ModelMixin):
     __tablename__ = "runs"
+    artifacts = relationship("Artifact")
     component = Column(Text, index=True)
     created = Column(DateTime, default=datetime.utcnow, index=True)
     # this is metadata but it is a reserved attr

backend/ibutsu_server/db/upgrades.py

@@ -7,7 +7,7 @@
 from sqlalchemy.sql import quoted_name
 from sqlalchemy.sql.expression import null
 
-__version__ = 2
+__version__ = 3
 
 
 def get_upgrade_op(session):
@@ -33,7 +33,7 @@ def upgrade_1(session):
     if (
         "dashboards" in metadata.tables
         and widget_configs is not None
-        and not widget_configs.columns.contains_column("dashboard_id")
+        and not hasattr(widget_configs.columns, "dashboard_id")
     ):
         op.add_column("widget_configs", Column("dashboard_id", PortableUUID, server_default=null()))
         if engine.url.get_dialect().name != "sqlite":
@@ -85,3 +85,33 @@ def upgrade_2(session):
                     [quoted_name("(data->'requirements')", False)],
                     postgresql_using="gin",
                 )
+
+
+def upgrade_3(session):
+    """Version 3 upgrade
+
+    This upgrade:
+        - makes the 'result_id' column of artifacts nullable
+        - adds a 'run_id' to the artifacts table
+    """
+    engine = session.get_bind()
+    op = get_upgrade_op(session)
+    metadata = MetaData()
+    metadata.reflect(bind=engine)
+    artifacts = metadata.tables.get("artifacts")
+    if (
+        "runs" in metadata.tables
+        and artifacts is not None
+        and not hasattr(artifacts.columns, "run_id")
+    ):
+        op.alter_column("artifacts", "result_id", nullable=True, server_default=null())
+        op.add_column("artifacts", Column("run_id", PortableUUID, server_default=null()))
+        if engine.url.get_dialect().name != "sqlite":
+            # SQLite doesn't support ALTER TABLE ADD CONSTRAINT
+            op.create_foreign_key(
+                "fk_artifacts_run_id",
+                "artifacts",
+                "runs",
+                ["run_id"],
+                ["id"],
+            )

backend/ibutsu_server/openapi/openapi.yaml

@@ -183,6 +183,16 @@ paths:
         required: false
         schema:
           type: string
+          format: uuid
+        style: form
+      - description: The run ID to filter by
+        explode: true
+        in: query
+        name: runId
+        required: false
+        schema:
+          type: string
+          format: uuid
         style: form
       - $ref: '#/components/parameters/Page'
       - $ref: '#/components/parameters/PageSize'
@@ -207,6 +217,9 @@ paths:
                 resultId:
                   description: ID of result to attach artifact to
                   type: string
+                runId:
+                  description: ID of run to attach artifact to
+                  type: string
                 filename:
                   description: ID of pet to update
                   type: string
@@ -218,7 +231,6 @@ paths:
                   description: Additional data to pass to server
                   type: object
               required:
-              - resultId
               - file
               - filename
               type: object
@@ -1668,6 +1680,10 @@ components:
           description: ID of test result to attach artifact to
           example: a16ad60e-bf23-4195-99dc-594858ad3e5e
           type: string
+        run_id:
+          description: ID of test run to attach artifact to
+          example: 04af3d2a-55c5-4562-9ed6-3bf30ac6753e
+          type: string
         filename:
           description: ID of pet to update
           type: string