[DRAFT] Issue-105 Add artifacts support for steps

Author: GolubNick

java-reporter-core/src/main/java/io/testomat/core/annotation/Step.java

@@ -9,4 +9,5 @@
 @Target(ElementType.METHOD)
 public @interface Step {
     String value() default "";
+    String[] artifacts() default {};
 }

java-reporter-core/src/main/java/io/testomat/core/client/request/NativeRequestBodyBuilder.java

@@ -14,6 +14,7 @@
 import io.testomat.core.constants.ApiRequestFields;
 import io.testomat.core.exception.FailedToCreateRunBodyException;
 import io.testomat.core.facade.methods.artifact.ReportedTestStorage;
+import io.testomat.core.facade.methods.artifact.TempArtifactDirectoriesStorage;
 import io.testomat.core.facade.methods.label.LabelStorage;
 import io.testomat.core.facade.methods.logmethod.LogStorage;
 import io.testomat.core.facade.methods.meta.MetaStorage;
@@ -158,6 +159,18 @@ private Map<String, Object> buildTestResultMap(TestResult result) throws JsonPro
         }
 
         if (result.getSteps() != null && !result.getSteps().isEmpty()) {
+            result.getSteps().forEach(step -> {
+                List<String> links =
+                    TempArtifactDirectoriesStorage.STEP_DIRECTORIES
+                        .remove(step.getId());
+                if (links == null || links.isEmpty()) {
+                    return;
+                }
+                step.setArtifacts(
+                    links.toArray(new String[0])
+                );
+            });
+
             List<Map<String, Object>> stepsMap = convertStepsToMap(result.getSteps());
             body.put("steps", stepsMap);
             System.out.println("DEBUG: Adding " + result.getSteps().size() + " steps to request body for test: " + result.getTitle());
@@ -203,6 +216,14 @@ private List<Map<String, Object>> convertStepsToMap(List<TestStep> steps) {
                 stepMap.put("title", step.getStepTitle());
             }
 
+            if (step.getArtifacts() != null) {
+                stepMap.put("artifacts", step.getArtifacts());
+            }
+
+            if (step.getStatus() != null) {
+                stepMap.put("status", step.getStatus());
+            }
+
             stepMap.put("duration", step.getDuration());
 
             if (step.getSubsteps() != null && !step.getSubsteps().isEmpty()) {

java-reporter-core/src/main/java/io/testomat/core/facade/Testomatio.java

@@ -4,8 +4,10 @@
 import io.testomat.core.facade.methods.label.LabelStorage;
 import io.testomat.core.facade.methods.logmethod.LogStorage;
 import io.testomat.core.facade.methods.meta.MetaStorage;
+import io.testomat.core.step.StepLifecycle;
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 
 /**
  * Main public API facade for Testomat.io integration.
@@ -21,6 +23,15 @@ public static void artifact(String... directories) {
         ServiceRegistryUtil.getService(ArtifactManager.class).storeDirectories(directories);
     }
 
+    public static void stepArtifact(String... directories) {
+        UUID stepId = StepLifecycle.current();
+        ServiceRegistryUtil.getService(ArtifactManager.class).storeStepDirectories(stepId, directories);
+    }
+
+    public static void stepArtifact(UUID stepId, String... directories) {
+        ServiceRegistryUtil.getService(ArtifactManager.class).storeStepDirectories(stepId, directories);
+    }
+
     public static void meta(String key, String value) {
         MetaStorage.TEMP_META_STORAGE.get().put(key, value);
     }

java-reporter-core/src/main/java/io/testomat/core/facade/methods/artifact/TempArtifactDirectoriesStorage.java

@@ -1,16 +1,26 @@
 package io.testomat.core.facade.methods.artifact;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
 
 /**
  * Thread-local storage for temporarily holding artifact file paths during test execution.
  * Ensures thread safety when multiple tests run concurrently.
  */
 public class TempArtifactDirectoriesStorage {
     public static final ThreadLocal<List<String>> DIRECTORIES = ThreadLocal.withInitial(ArrayList::new);
+    public static final ConcurrentHashMap<UUID, List<String>> STEP_DIRECTORIES = new ConcurrentHashMap<>();
 
     public static void store(String dir) {
         DIRECTORIES.get().add(dir);
     }
+    public static void stepStore(UUID stepId, String dir) {
+        STEP_DIRECTORIES
+            .computeIfAbsent(stepId,
+            k -> Collections.synchronizedList(new ArrayList<>()))
+            .add(dir);
+    }
 }

java-reporter-core/src/main/java/io/testomat/core/facade/methods/artifact/client/AwsService.java

@@ -74,6 +74,10 @@ public void uploadAllArtifactsForTest(String testName, String rid, String testId
         S3Credentials credentials = CredentialsManager.getCredentials();
         List<String> uploadedArtifactsLinks = processArtifacts(artifactDirectories, testName, rid, credentials);
 
+        if (!TempArtifactDirectoriesStorage.STEP_DIRECTORIES.isEmpty()) {
+            processStepArtifacts(testName, rid, credentials);
+        }
+
         storeArtifactLinkData(testName, rid, testId, uploadedArtifactsLinks);
 
         // Clear artifact directories after processing
@@ -92,6 +96,19 @@ private List<String> processArtifacts(List<String> artifactDirectories, String t
         return uploadedLinks;
     }
 
+    private void processStepArtifacts(String testName, String rid, S3Credentials credentials) {
+
+        TempArtifactDirectoriesStorage.STEP_DIRECTORIES
+            .forEach((stepId, list) -> list.replaceAll(dir -> {
+                if (dir.startsWith("http")) {
+                    return dir;
+                }
+                String key = keyGenerator.generateKey(dir, rid, testName);
+                uploadArtifact(dir, key, credentials);
+                return urlGenerator.generateUrl(credentials.getBucket(), key);
+            }));
+    }
+
     private void storeArtifactLinkData(String testName, String rid, String testId, List<String> uploadedLinks) {
         ArtifactLinkData linkData = new ArtifactLinkData(testName, rid, testId, uploadedLinks);
         ArtifactLinkDataStorage.ARTEFACT_LINK_DATA_STORAGE.add(linkData);

java-reporter-core/src/main/java/io/testomat/core/facade/methods/artifact/manager/ArtifactManager.java

@@ -11,19 +11,34 @@
 import java.nio.file.InvalidPathException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.UUID;
+import java.util.function.Consumer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class ArtifactManager {
     private static final Logger log = LoggerFactory.getLogger(ArtifactManager.class);
 
     public void storeDirectories(String... directories) {
+        store(directories,
+            TempArtifactDirectoriesStorage::store,
+            "Invalid artifact path provided: {}");
+    }
+
+    public void storeStepDirectories(UUID stepId, String... directories) {
+        store(directories,
+            dir -> TempArtifactDirectoriesStorage.stepStore(stepId, dir),
+            "Invalid step artifact path provided: {}");
+    }
+
+    private void store(String[] directories, Consumer<String> storage, String logMessage) {
+
         for (String dir : directories) {
-            if (isValidFilePath(dir)) {
-                TempArtifactDirectoriesStorage.store(dir);
-            } else {
-                log.info("Invalid artifact path provided: {}", dir);
+            if (!isValidFilePath(dir)) {
+                log.info(logMessage, dir);
+                continue;
             }
+            storage.accept(dir);
         }
     }
 

java-reporter-core/src/main/java/io/testomat/core/step/StepAspect.java

@@ -1,6 +1,9 @@
 package io.testomat.core.step;
 
+import static io.testomat.core.facade.Testomatio.stepArtifact;
+
 import io.testomat.core.annotation.Step;
+import java.util.UUID;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
@@ -29,40 +32,45 @@ public class StepAspect {
     @Around("execution(@io.testomat.core.annotation.Step * *(..)) && @annotation(step)")
     public Object aroundStep(ProceedingJoinPoint joinPoint, Step step) throws Throwable {
         String stepName = resolveStepName(joinPoint, step);
+        String[] artifacts = resolveAttachments(step);
         long startTime = System.currentTimeMillis();
 
         log.info("Step aspect triggered for: {}", stepName);
-
+        StepLifecycle.start(UUID.randomUUID());
+        Object result;
         try {
-            return executeStepSuccessfully(joinPoint, stepName, startTime);
+            result = executeStepSuccessfully(joinPoint, stepName, artifacts, startTime);
         } catch (Throwable e) {
-            handleStepFailure(stepName, startTime, e);
+            handleStepFailure(stepName, artifacts, startTime, e);
             throw e;
+        } finally {
+            StepLifecycle.finish();
         }
+        return result;
     }
 
-    private Object executeStepSuccessfully(ProceedingJoinPoint joinPoint, String stepName, long startTime) throws Throwable {
+    private Object executeStepSuccessfully(ProceedingJoinPoint joinPoint, String stepName, String[] artifacts, long startTime) throws Throwable {
         Object result = joinPoint.proceed();
         long duration = calculateDuration(startTime);
 
-        recordStep(stepName, duration);
+        recordStep(stepName, artifacts, StepStatus.passed, duration);
         log.info("Step '{}' added to storage. Total steps: {}", stepName, StepStorage.getSteps().size());
 
         return result;
     }
 
-    private void handleStepFailure(String stepName, long startTime, Throwable e) {
+    private void handleStepFailure(String stepName, String[] artifacts, long startTime, Throwable e) {
         long duration = calculateDuration(startTime);
         log.error("Step '{}' failed after {} ms", stepName, duration, e);
-        recordStep(stepName, duration);
+        recordStep(stepName, artifacts, StepStatus.failed, duration);
     }
 
     private long calculateDuration(long startTime) {
         return System.currentTimeMillis() - startTime;
     }
 
-    private void recordStep(String stepName, long duration) {
-        TestStep testStep = createTestStep(stepName, duration);
+    private void recordStep(String stepName, String[] artifacts, StepStatus stepStatus, long duration) {
+        TestStep testStep = createTestStep(stepName, artifacts, stepStatus, duration);
         StepStorage.addStep(testStep);
     }
 
@@ -87,6 +95,13 @@ private String getStepNameTemplate(ProceedingJoinPoint joinPoint, Step step) {
         return signature.getName();
     }
 
+    private String[] resolveAttachments(Step step) {
+        if (step.artifacts() != null && step.artifacts().length > 0) {
+            return step.artifacts();
+        }
+        return null;
+    }
+
     /**
      * Substitutes parameter placeholders in the step name with actual parameter values.
      * Supports both indexed placeholders {0}, {1}, etc. and named placeholders {parameterName}.
@@ -157,12 +172,17 @@ private String formatParameterValue(Object value) {
      * @param durationMillis the execution duration in milliseconds
      * @return populated TestStep object
      */
-    private TestStep createTestStep(String stepName, long durationMillis) {
+    private TestStep createTestStep(String stepName, String[] artifacts, StepStatus stepStatus, long durationMillis) {
         TestStep testStep = new TestStep();
+        testStep.setId(StepLifecycle.current());
         testStep.setCategory("user");
         testStep.setStepTitle(stepName);
+        testStep.setStatus(stepStatus);
         testStep.setDuration(durationMillis);
 
+        if (artifacts != null) {
+            stepArtifact(testStep.getId(), artifacts);
+        }
         log.debug("Step '{}' completed in {} ms", stepName, durationMillis);
 
         return testStep;

java-reporter-core/src/main/java/io/testomat/core/step/StepLifecycle.java

@@ -0,0 +1,23 @@
+package io.testomat.core.step;
+
+import java.util.ArrayDeque;
+import java.util.Deque;
+import java.util.UUID;
+
+public class StepLifecycle {
+
+    private static final ThreadLocal<Deque<UUID>> CURRENT_STEPS =
+        ThreadLocal.withInitial(ArrayDeque::new);
+
+    public static void start(UUID stepId) {
+        CURRENT_STEPS.get().push(stepId);
+    }
+
+    public static void finish() {
+        CURRENT_STEPS.get().pop();
+    }
+
+    public static UUID current() {
+        return CURRENT_STEPS.get().peek();
+    }
+}

java-reporter-core/src/main/java/io/testomat/core/step/StepStatus.java

@@ -0,0 +1,5 @@
+package io.testomat.core.step;
+
+public enum StepStatus {
+    passed, failed, none
+}

java-reporter-core/src/main/java/io/testomat/core/step/TestStep.java

@@ -2,12 +2,16 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.UUID;
 
 public class TestStep {
+    private UUID id;
     private String category;
     private String stepTitle;
+    private StepStatus status;
     private double duration;
     private List<TestStep> substeps = new ArrayList<>();
+    private String[] artifacts;
 
     public String getCategory() {
         return category;
@@ -40,4 +44,28 @@ public List<TestStep> getSubsteps() {
     public void setSubsteps(List<TestStep> substeps) {
         this.substeps = substeps;
     }
+
+    public String[] getArtifacts() {
+        return artifacts;
+    }
+
+    public void setArtifacts(String[] artifacts) {
+        this.artifacts = artifacts;
+    }
+
+    public void setId(UUID id) {
+        this.id = id;
+    }
+
+    public UUID getId() {
+        return id;
+    }
+
+    public StepStatus getStatus() {
+        return status;
+    }
+
+    public void setStatus(StepStatus status) {
+        this.status = status;
+    }
 }