Merge pull request #40 from stack-spot/bugfix/release-0.1.4

Release 0.1.4

Author: matheusferreirazup

.github/workflows/deploy-prod.yml

@@ -76,7 +76,7 @@ jobs:
 
           gh pr create \
             --title "Changelog update - \`$VERSION\`" \
-            --body "current pull request contains patched \`changelog.md\` file for the \`$version\` version." \
+            --body "Current pull request contains patched \`changelog.md\` file for the \`$VERSION\` version." \
             --base "${{ github.event.release.target_commitish }}" \
             --head $BRANCH \
             --label ignore-for-release

CHANGELOG.md

@@ -2,4 +2,24 @@
 
 ## Releases
 
+## [v0.1.4] - 2022-09-21
+<!-- Release notes generated using configuration in .github/release.yaml at release-0.1.4 -->
 
+### Exciting New Features 🎉
+* Feature: Improve plugin description in marketplace page by @matheusferreirazup in https://github.com/stack-spot/stackspot-intellij-extension/pull/19
+* Feature: changed the documentation url inside the readme by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/22
+* Feature: Created workflow to generate release notes and publish plugin by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/23
+* Feature: Add Sonarqube and first unit tests by @matheusferreirazup in https://github.com/stack-spot/stackspot-intellij-extension/pull/33
+### Bug Fixes 🛠
+* Bug fix: Project wizard always stuck in "no stackfiles panel"  by @matheusferreirazup in https://github.com/stack-spot/stackspot-intellij-extension/pull/17
+* Bug fix: Stack url dialog by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/18
+* Bug fix: added validation if stack file exists inside stack by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/20
+* Bug Fix: Changed workflows for each event type and corrected the workflow for plugin publishing by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/26
+* Bug Fix: Changed workflows for plugin publishing by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/27
+* Bug Fix: Moved changelog jobs into deploy prod workflow by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/28
+* Bug Fix: Changed changelog extension in build gradle and disable buildSearchableOptions by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/29
+* Bug Fix: Added project version property in update changelog command by @adroaldonetozup in https://github.com/stack-spot/stackspot-intellij-extension/pull/30
+### Other Changes
+* Refactor: Change reusable workflows to use the main branch instead of release branch by @matheusferreirazup in https://github.com/stack-spot/stackspot-intellij-extension/pull/24
+
+Full Changelog: https://github.com/stack-spot/stackspot-intellij-extension/compare/v0.0.3...v0.1.4

build.gradle.kts

@@ -1,35 +1,62 @@
 import org.jetbrains.changelog.date
 
+fun properties(key: String) = project.findProperty(key).toString()
+
 plugins {
     id("java")
+    id("jacoco")
     id("org.jetbrains.kotlin.jvm") version "1.7.10"
     id("org.jetbrains.intellij") version "1.8.0"
+    id("org.sonarqube") version "3.4.0.2513"
 
     // Gradle Changelog Plugin
     id("org.jetbrains.changelog") version "1.3.1"
 }
 
-group = "com.stackspot"
-version = System.getProperty("project_version")
+val projectVersion: String? = System.getProperty("project_version")
+
+group = properties("pluginGroup")
+version = if (projectVersion.isNullOrEmpty()) {
+    properties("pluginVersion")
+} else {
+    projectVersion
+}
 
 repositories {
     mavenCentral()
 }
 
+dependencies {
+    testImplementation(platform("org.junit:junit-bom:5.9.0"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
+}
+
+kotlin {
+    jvmToolchain {
+        languageVersion.set(JavaLanguageVersion.of(11))
+    }
+}
+
 // Configure Gradle IntelliJ Plugin - read more: https://github.com/JetBrains/gradle-intellij-plugin
 intellij {
-    version.set("2022.1")
-    type.set("IC") // Target IDE Platform
+    pluginName.set(properties("pluginName"))
+    version.set(properties("platformVersion"))
+    type.set(properties("platformType")) // Target IDE Platform
 
     plugins.set(
-        listOf(
-            "org.jetbrains.plugins.terminal",
-            "com.intellij.gradle",
-            "org.jetbrains.idea.maven",
-        )
+        properties("platformPlugins")
+            .split(',')
+            .map(String::trim)
+            .filter(String::isNotEmpty)
     )
 }
 
+sonarqube {
+    properties {
+        property("sonar.projectName", "ide-intellij-plugin")
+    }
+}
+
 // Configure Gradle Changelog Plugin - read more: https://github.com/JetBrains/gradle-changelog-plugin
 changelog {
     val regex =
@@ -50,13 +77,22 @@ tasks {
         sourceCompatibility = "11"
         targetCompatibility = "11"
     }
+
     withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
         kotlinOptions.jvmTarget = "11"
     }
 
+    buildSearchableOptions {
+        enabled = false
+    }
+
+    wrapper {
+        gradleVersion = properties("gradleVersion")
+    }
+
     patchPluginXml {
-        sinceBuild.set("221")
-        untilBuild.set("222.*")
+        sinceBuild.set(properties("pluginSinceBuild"))
+        untilBuild.set(properties("pluginUntilBuild"))
     }
 
     buildSearchableOptions {
@@ -67,4 +103,19 @@ tasks {
         token.set(System.getenv("PUBLISH_TOKEN"))
         channels.set(listOf(System.getenv("MARKETPLACE_CHANNEL")))
     }
+
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events("passed", "skipped", "failed")
+        }
+        finalizedBy(jacocoTestReport)
+    }
+
+    jacocoTestReport {
+        dependsOn(test)
+        reports {
+            xml.required.set(true)
+        }
+    }
 }

gradle.properties

@@ -0,0 +1,32 @@
+#
+# Copyright 2022 ZUP IT SERVICOS EM TECNOLOGIA E INOVACAO SA
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+pluginGroup = com.stackspot
+pluginName = stackspot-intellij-plugin
+pluginVersion = test-0.0.1
+
+pluginSinceBuild = 221
+pluginUntilBuild = 222.*
+
+platformType = IC
+platformVersion = 2022.1
+platformPlugins = org.jetbrains.plugins.terminal, com.intellij.gradle, org.jetbrains.idea.maven
+
+gradleVersion = 7.5.1
+
+# Opt-out flag for bundling Kotlin standard library -> https://plugins.jetbrains.com/docs/intellij/kotlin.html#kotlin-standard-library
+# suppress inspection "UnusedProperty"
+kotlin.stdlib.default.dependency = false

src/main/kotlin/com/stackspot/intellij/services/CreateProjectService.kt

@@ -53,9 +53,10 @@ class CreateProjectService {
         stackfile = null
     }
 
-    fun saveInfo(stack: Stack?, stackfile: Stackfile?) {
+    fun saveInfo(stack: Stack?, stackfile: Stackfile?): CreateProjectService {
         this.stack = stack
         this.stackfile = stackfile
+        return this
     }
 
     fun addGitConfig(username: String, email: String) {

src/main/kotlin/com/stackspot/model/Stack.kt

@@ -26,10 +26,10 @@ import java.util.*
 data class Stack(
     val name: String,
     val description: String,
-    val displayName: String?,
-    @JsonProperty("display-name") val displayNameKebab: String?,
-    val useCases: List<StackUseCase>?,
-    @JsonProperty("use-cases") val useCasesKebab: List<StackUseCase>?
+    val displayName: String? = null,
+    @JsonProperty("display-name") val displayNameKebab: String? = null,
+    val useCases: List<StackUseCase>? = null,
+    @JsonProperty("use-cases") val useCasesKebab: List<StackUseCase>? = null
 ) {
     lateinit var location: File
 

src/main/kotlin/com/stackspot/model/Stackfile.kt

@@ -20,8 +20,8 @@ data class Stackfile(
     val type: String,
     val description: String,
     val template: String,
-    val inputs: Map<String, Any>?,
-    val plugins: List<StackfilePlugin>?
+    val inputs: Map<String, Any>? = null,
+    val plugins: List<StackfilePlugin>? = null
 ) {
     lateinit var name: String
 }

src/test/kotlin/com/stackspot/services/CreateProjectServiceTest.kt

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2022 ZUP IT SERVICOS EM TECNOLOGIA E INOVACAO SA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.stackspot.services
+
+import com.stackspot.intellij.services.CreateProjectService
+import com.stackspot.model.Stack
+import com.stackspot.model.Stackfile
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.Arguments
+import org.junit.jupiter.params.provider.MethodSource
+import java.util.stream.Stream
+
+class CreateProjectServiceTest {
+
+    @ParameterizedTest
+    @MethodSource("saveInfoArgs")
+    fun `should saveInfo when args are nullable and when they don't`(stack: Stack?, stackfile: Stackfile?) {
+        val service = CreateProjectService().saveInfo(stack, stackfile)
+        Assertions.assertEquals(stack, service.stack)
+        Assertions.assertEquals(stackfile, service.stackfile)
+    }
+
+    @ParameterizedTest
+    @MethodSource("stackfileIsSelectedArgs")
+    fun `should check if stackfile is selected and when it don't`(
+        stack: Stack?,
+        stackfile: Stackfile?,
+        expected: Boolean
+    ) {
+        val service = CreateProjectService().saveInfo(stack, stackfile)
+        Assertions.assertEquals(service.isStackfileSelected(), expected)
+    }
+
+    private companion object {
+        @JvmStatic
+        fun stackfileIsSelectedArgs(): Stream<Arguments> =
+            Stream.of(
+                Arguments.of(
+                    null, null, false
+                ),
+                Arguments.of(
+                    createStack(),
+                    createStackfile(),
+                    true
+                )
+            )
+
+        @JvmStatic
+        fun saveInfoArgs(): Stream<Arguments> =
+            Stream.of(
+                Arguments.of(
+                    null, null
+                ),
+                Arguments.of(
+                    createStack(),
+                    createStackfile()
+                )
+            )
+
+        private fun createStack(name: String = "stack-for-test", description: String = "stack test description") =
+            Stack(name, description)
+
+        private fun createStackfile(
+            type: String = "app",
+            description: String = "stackfile test description",
+            template: String = "test-tempalte"
+        ) = Stackfile(type, description, template)
+    }
+}