add @LabelAnnotation for @kjira to support integration between Allure…

… TestOps and Jira (#11) add @kTag annotation
kochetkov-ma · Aug 8, 2023 · e9af160 · e9af160
1 parent 7566ff0
commit e9af160
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 3 deletions.
diff --git a/src/main/kotlin/ru/iopump/kotest/allure/annotation/KJira.kt b/src/main/kotlin/ru/iopump/kotest/allure/annotation/KJira.kt
@@ -1,6 +1,8 @@
 package ru.iopump.kotest.allure.annotation
 
+import io.qameta.allure.LabelAnnotation
 import io.qameta.allure.LinkAnnotation
+import ru.iopump.kotest.allure.api.KotestAllureConstant.JIRA.LABEL_NAME
 import ru.iopump.kotest.allure.api.KotestAllureConstant.JIRA.LINK_TYPE
 import java.lang.annotation.Inherited
 
@@ -9,5 +11,6 @@ import java.lang.annotation.Inherited
 @Retention(AnnotationRetention.RUNTIME)
 @Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
 @LinkAnnotation(type = LINK_TYPE)
+@LabelAnnotation(name = LABEL_NAME)
 @Repeatable
 annotation class KJira(val value: String)
diff --git a/src/main/kotlin/ru/iopump/kotest/allure/annotation/KTag.kt b/src/main/kotlin/ru/iopump/kotest/allure/annotation/KTag.kt
@@ -0,0 +1,13 @@
+package ru.iopump.kotest.allure.annotation
+
+import io.qameta.allure.LabelAnnotation
+import io.qameta.allure.util.ResultsUtils.TAG_LABEL_NAME
+import java.lang.annotation.Inherited
+
+@MustBeDocumented
+@Inherited
+@Retention(AnnotationRetention.RUNTIME)
+@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
+@LabelAnnotation(name = TAG_LABEL_NAME)
+@Repeatable
+annotation class KTag(val value: String)
diff --git a/src/main/kotlin/ru/iopump/kotest/allure/annotation/KTags.kt b/src/main/kotlin/ru/iopump/kotest/allure/annotation/KTags.kt
@@ -0,0 +1,15 @@
+package ru.iopump.kotest.allure.annotation
+
+import java.lang.annotation.Inherited
+
+@MustBeDocumented
+@Inherited
+@Retention(AnnotationRetention.RUNTIME)
+@Target(
+    AnnotationTarget.FUNCTION,
+    AnnotationTarget.PROPERTY_GETTER,
+    AnnotationTarget.PROPERTY_SETTER,
+    AnnotationTarget.ANNOTATION_CLASS,
+    AnnotationTarget.CLASS
+)
+annotation class KTags(val value: Array<KTag>)
diff --git a/src/main/kotlin/ru/iopump/kotest/allure/api/KotestAllureConstant.kt b/src/main/kotlin/ru/iopump/kotest/allure/api/KotestAllureConstant.kt
@@ -16,6 +16,8 @@ object KotestAllureConstant {
     object JIRA {
 
         const val LINK_TYPE = "jira"
+
+        const val LABEL_NAME = "jira"
 
         internal const val PATTERN_DEFAULT = "\\[([a-zA-Z]+-\\d+)]"
 

diff --git a/src/main/kotlin/ru/iopump/kotest/allure/helper/meta/AllureMetadata.kt b/src/main/kotlin/ru/iopump/kotest/allure/helper/meta/AllureMetadata.kt
@@ -7,6 +7,7 @@ import io.qameta.allure.model.Link
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportDescriptions.kDescription
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportLabels.allureIdsFromTestName
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportLabels.epicFromPkg
+import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportLabels.jiraLabelsFromTestName
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportLabels.labelAnnotations
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportLabels.severity
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupportLinks.issues
@@ -28,6 +29,7 @@ internal class AllureMetadata(
         add(specClass.severity)
         add(specClass.epicFromPkg)
         addAll(description.allureIdsFromTestName)
+        addAll(description.jiraLabelsFromTestName)
     }.filterNotNull()
 
     internal val allLinks: List<Link> = buildList {

diff --git a/src/main/kotlin/ru/iopump/kotest/allure/helper/meta/AllureMetadataSupportLabels.kt b/src/main/kotlin/ru/iopump/kotest/allure/helper/meta/AllureMetadataSupportLabels.kt
@@ -8,6 +8,7 @@ import io.qameta.allure.model.Label
 import io.qameta.allure.util.AnnotationUtils
 import io.qameta.allure.util.ResultsUtils.*
 import ru.iopump.kotest.allure.api.KotestAllureConstant
+import ru.iopump.kotest.allure.api.KotestAllureConstant.JIRA
 import ru.iopump.kotest.allure.helper.meta.AllureMetadataSupport.findAll
 import kotlin.reflect.KClass
 import kotlin.reflect.full.findAnnotation
@@ -28,4 +29,12 @@ internal object AllureMetadataSupportLabels {
                 .map { key -> createLabel(ALLURE_ID_LABEL_NAME, key) }
                 .toList()
         }.orEmpty()
+
+    internal inline val Descriptor?.jiraLabelsFromTestName: Collection<Label>
+        get() = this?.run {
+            id.value
+                .findAll(JIRA.PATTERN)
+                .map { key -> createLabel(JIRA.LABEL_NAME, key) }
+                .toList()
+        }.orEmpty()
 }
diff --git a/src/test/kotlin/ru/iopump/kotest/allure/ExampleBddSpec.kt b/src/test/kotlin/ru/iopump/kotest/allure/ExampleBddSpec.kt
@@ -9,9 +9,7 @@ import io.qameta.allure.Issue
 import io.qameta.allure.Issues
 import io.qameta.allure.Link
 import io.qameta.allure.Links
-import ru.iopump.kotest.allure.annotation.KDescription
-import ru.iopump.kotest.allure.annotation.KJira
-import ru.iopump.kotest.allure.annotation.KJiras
+import ru.iopump.kotest.allure.annotation.*
 
 @Epic("Allure feature annotation on test class")
 @Feature("Behavior")
@@ -30,6 +28,11 @@ import ru.iopump.kotest.allure.annotation.KJiras
 @KJiras(
     value = [KJira("TTT-111"), KJira("TTT-000")]
 )
+@KAllureId("888")
+@KTag("autotest")
+@KTags(
+    value = [KTag("auto"), KTag("test")]
+)
 class ExampleBddSpec : BehaviorSpec() {
 
     init {