Merge pull request #23 from linked-planet/feature/add_jira_attribute_schema

Feature/add jira attribute schema

Author: HighKo

kotlin-jira-client/kotlin-jira-client-api/src/main/kotlin/com/linkedplanet/kotlinjiraclient/api/model/Model.kt

@@ -43,7 +43,16 @@ data class JiraIssueType(
 
 data class JiraIssueTypeAttribute(
     val id: String,
-    val name: String
+    val name: String,
+    val schema: JiraIssueTypeAttributeSchema
+)
+
+data class JiraIssueTypeAttributeSchema(
+    val type: String, // "date" see com.atlassian.jira.issue.fields.rest.json.JsonType
+    val items: String?, // unclear what this is
+    val system: String?, // only used if its a system field, e.g. "assignee"
+    val custom: String?, // e.g. com.atlassian.jira.plugin.system.customfieldtypes:datepicker
+    val customId: Long? // e.g. 10202
 )
 
 data class JiraIssue(

kotlin-jira-client/kotlin-jira-client-http/src/main/kotlin/com/linkedplanet/kotlinjiraclient/http/model/HttpModel.kt

@@ -93,13 +93,34 @@ fun List<HttpJiraIssueType>.toJiraIssueTypes(): List<JiraIssueType> =
     map { it.toJiraIssueType() }
 
 data class HttpJiraIssueTypeAttribute(
+    val required: Boolean,
+    val schema: HttpJiraIssueTypeAttributeJsonSchema?,
     val name: String,
-    val fieldId: String
+    val fieldId: String,
+    val hasDefaultValue: Boolean,
 ) {
     fun toJiraIssueTypeAttribute() =
-        JiraIssueTypeAttribute(fieldId, name)
+        JiraIssueTypeAttribute(
+            fieldId,
+            name,
+            JiraIssueTypeAttributeSchema(
+                schema?.type ?: "Any",
+                schema?.items,
+                schema?.system,
+                schema?.custom,
+                schema?.customId,
+            )
+        )
 }
 
+data class HttpJiraIssueTypeAttributeJsonSchema(
+    val type: String, // "date" see com.atlassian.jira.issue.fields.rest.json.JsonType
+    val items: String?, // unclear what this is
+    val system: String?, // only used if its a system field, e.g. "assignee"
+    val custom: String?, // e.g. com.atlassian.jira.plugin.system.customfieldtypes:datepicker
+    val customId: Long? // e.g. 10202
+)
+
 fun List<HttpJiraIssueTypeAttribute>.toJiraIssueTypeAttributes(): List<JiraIssueTypeAttribute> =
     map { it.toJiraIssueTypeAttribute() }
 

kotlin-jira-client/kotlin-jira-client-sdk/src/main/kotlin/com/linkedplanet/kotlinjiraclient/sdk/SdkJiraIssueTypeOperator.kt

@@ -23,13 +23,17 @@ import arrow.core.Either
 import com.atlassian.jira.bc.project.ProjectService
 import com.atlassian.jira.component.ComponentAccessor
 import com.atlassian.jira.config.IssueTypeService
+import com.atlassian.jira.issue.fields.rest.RestAwareField
+import com.atlassian.jira.issue.fields.screen.FieldScreenLayoutItem
+import com.atlassian.jira.issue.fields.screen.FieldScreenTab
 import com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenSchemeManager
 import com.atlassian.jira.issue.issuetype.IssueType
 import com.atlassian.jira.issue.operation.IssueOperations
 import com.linkedplanet.kotlinjiraclient.api.error.JiraClientError
 import com.linkedplanet.kotlinjiraclient.api.interfaces.JiraIssueTypeOperator
 import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueType
 import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueTypeAttribute
+import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueTypeAttributeSchema
 import com.linkedplanet.kotlinjiraclient.sdk.util.eitherAndCatch
 import com.linkedplanet.kotlinjiraclient.sdk.util.toEither
 import javax.inject.Named
@@ -56,9 +60,21 @@ object SdkJiraIssueTypeOperator : JiraIssueTypeOperator {
             )
             val screenScheme = screenSchemes.getEffectiveFieldScreenScheme(issueType)
             val createScreen = screenScheme.getFieldScreen(IssueOperations.CREATE_ISSUE_OPERATION)
-            val fields = createScreen.tabs.flatMap { screenTab ->
-                screenTab.fieldScreenLayoutItems.map { layoutItem ->
-                    JiraIssueTypeAttribute(layoutItem.orderableField.id, layoutItem.orderableField.name)
+            val fields = createScreen.tabs.flatMap { screenTab: FieldScreenTab ->
+                screenTab.fieldScreenLayoutItems.map { layoutItem: FieldScreenLayoutItem ->
+                    val orderableField = layoutItem.orderableField
+                    val schema = (orderableField as? RestAwareField)?.jsonSchema
+                    JiraIssueTypeAttribute(
+                        id = orderableField.id,
+                        name = orderableField.name,
+                        schema = JiraIssueTypeAttributeSchema(
+                            schema?.type ?: "Any",
+                            schema?.items,
+                            schema?.system,
+                            schema?.custom,
+                            schema?.customId,
+                        )
+                    )
                 }
             }
             fields

kotlin-jira-client/kotlin-jira-client-test-base/src/main/kotlin/com/linkedplanet/kotlinjiraclient/JiraIssueTypeOperatorTest.kt

@@ -22,7 +22,7 @@ package com.linkedplanet.kotlinjiraclient
 import com.linkedplanet.kotlinjiraclient.api.model.JiraIssueTypeAttribute
 import com.linkedplanet.kotlinjiraclient.util.orFail
 import kotlinx.coroutines.runBlocking
-import org.hamcrest.CoreMatchers.equalTo
+import org.hamcrest.CoreMatchers.*
 import org.hamcrest.MatcherAssert.assertThat
 import org.junit.Test
 
@@ -51,16 +51,17 @@ interface JiraIssueTypeOperatorTest<JiraFieldType> : BaseTestConfigProvider<Jira
                     issueTypeId
                 )
             }.orFail()
-        val expectedAttributes = listOf(
+        val expectedAttributes = arrayOf(
             "Epic Link", "Summary", "Issue Type", "Reporter", "Component/s", "Description",
             "Fix Version/s", "Priority", "Labels", "Attachment", "Linked Issues", "Assignee",
             "Sprint", "InsightObject"
         )   // Newer Jira does not include "Project
 
         val attributeNames = attributes.map(JiraIssueTypeAttribute::name)
         assertThat(attributeNames.size, equalTo(attributes.size))
-        expectedAttributes.forEach {
-            assertThat("Attributes does not contain: $it", attributeNames.contains(it), equalTo(true))
-        }
+        assertThat(attributeNames, hasItems(*expectedAttributes))
+
+        assertThat(attributes.firstOrNull { it.name == "Reporter" }?.schema?.type, equalTo("user"))
+        assertThat(attributes.firstOrNull { it.name == "Summary" }?.schema?.type, equalTo("string"))
     }
 }