Merge pull request #44 from 0xShubhamSolanki/add-publishTap-symbol

Add @symbol("publishTap") to TapPublisher Descriptor and pipeline test

Author: kinow

.gitignore

@@ -7,3 +7,5 @@ test-output/
 **/*~
 .idea
 *.iml
+.vscode/
+

CHANGES.md

@@ -2,7 +2,7 @@
 
 ## Version 2.4.5 (2025/??/??)
 
-- 
+- [GH-44](https://github.com/jenkinsci/tap-plugin/pull/44): Add @Symbol("publishTap") to TapPublisher Descriptor and pipeline test (thanks @0xShubhamSolanki)
 
 ## Version 2.4.4 (2025/03/13)
 

pom.xml

@@ -130,6 +130,16 @@ SOFTWARE.
       <artifactId>workflow-cps</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-step-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-basic-steps</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

src/main/java/org/tap4j/plugin/TapPublisher.java

@@ -40,6 +40,7 @@
 import org.tap4j.model.TestSet;
 import org.tap4j.plugin.model.TestSetMap;
 import org.tap4j.plugin.util.Constants;
+import org.jenkinsci.Symbol;
 
 import hudson.EnvVars;
 import hudson.Extension;
@@ -582,6 +583,7 @@ public MatrixAggregator createAggregator(MatrixBuild build, Launcher launcher, B
     }
 
     @Extension
+    @Symbol("publishTap")
     public static class DescriptorImpl extends BuildStepDescriptor<Publisher> {
         public DescriptorImpl() {
             super(TapPublisher.class);

src/test/java/org/tap4j/plugin/TapPublisherPipelineTest.java

@@ -0,0 +1,55 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2010-2026 Bruno P. Kinoshita
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ */
+package org.tap4j.plugin;
+
+import hudson.model.Result;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jenkinsci.plugins.workflow.job.WorkflowJob;
+import org.jenkinsci.plugins.workflow.job.WorkflowRun;
+import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
+
+public class TapPublisherPipelineTest {
+
+    @Rule
+    public JenkinsRule j = new JenkinsRule();
+
+    @Test
+    public void publishTapSymbolWorksWithValidTapFile() throws Exception {
+
+        WorkflowJob job = j.createProject(WorkflowJob.class);
+
+        job.setDefinition(new CpsFlowDefinition(
+            "node {\n" +
+            "  writeFile file: 'test.log', text: '1..1\\nok 1 - Sample test\\n'\n" +
+            "  publishTap(testResults: 'test.log')\n" +
+            "}",
+            true
+        ));
+
+        WorkflowRun run = j.buildAndAssertSuccess(job);
+
+        j.assertBuildStatus(Result.SUCCESS, run);
+        j.assertLogContains("TAP Reports Processing: START", run);
+        j.assertLogContains("TAP Reports Processing: FINISH", run);
+    }
+}
+