Merge "[feat][core] common utils for kaas per-commit testing"
diff --git a/src/com/mirantis/mk/KaasUtils.groovy b/src/com/mirantis/mk/KaasUtils.groovy
new file mode 100644
index 0000000..714c594
--- /dev/null
+++ b/src/com/mirantis/mk/KaasUtils.groovy
@@ -0,0 +1,132 @@
+package com.mirantis.mk
+common = new com.mirantis.mk.Common()
+
+/**
+ *
+ * KaaS Component Testing Utilities
+ *
+ */
+
+
+/**
+* Determine scope of test suite against per-commit KaaS deployment based on keywords
+* Keyword list: https://gerrit.mcp.mirantis.com/plugins/gitiles/kaas/core/+/refs/heads/master/.git-message-template#50
+*
+* Used for components team to combine test-suites and forward desired parameters to kaas/core deployment jobs
+* Example scheme:
+* New CR pushed in kubernetes/lcm-ansible -> parsing it's commit body and combine test-suite -> trigger deployment jobs from kaas/core
+* manage test-suite through Jenkins Job Parameters
+*
+* @return        (map)[
+*                    deployChildEnabled: (bool) True if need to deploy child cluster during demo-run
+*                    runUie2eEnabled: (bool) True if need to run ui-e2e cluster during demo-run
+*                   ]
+*/
+def checkDeploymentTestSuite() {
+    // Available triggers and its sane defaults
+    def deployChild = (env.DEPLOY_CHILD_CLUSTER != null ) ? env.DEPLOY_CHILD_CLUSTER.toBoolean() : false
+    def upgradeChild = (env.UPGRADE_CHILD_CLUSTER != null ) ? env.UPGRADE_CHILD_CLUSTER.toBoolean() : false
+    def upgradeMgmt = (env.UPGRADE_MGMT_CLUSTER != null ) ? env.UPGRADE_MGMT_CLUSTER.toBoolean() : false
+    def runUie2e = (env.RUN_UI_E2E != null ) ? env.RUN_UI_E2E.toBoolean() : false
+    def runMgmtConformance = (env.RUN_MGMT_CFM != null ) ? env.RUN_MGMT_CFM.toBoolean() : false
+    def runChildConformance = (env.RUN_CHILD_CFM != null ) ? env.RUN_CHILD_CFM.toBoolean() : false
+    def fetchServiceBinaries = (env.FETCH_BINARIES_FROM_UPSTREAM != null) ? env.FETCH_BINARIES_FROM_UPSTREAM.toBoolean() : false
+    def awsOnDemandDemo = (env.RUN_AWS_ON_DEMAND_DEMO != null) ? env.RUN_AWS_ON_DEMAND_DEMO.toBoolean() : false
+
+    def commitMsg = (env.GERRIT_CHANGE_COMMIT_MESSAGE != null) ? new String(env.GERRIT_CHANGE_COMMIT_MESSAGE.decodeBase64()) : ''
+    if (commitMsg ==~ /(?s).*\[child-deploy\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*child-deploy.*/ || upgradeChild || runChildConformance) {
+        deployChild = true
+    }
+    if (commitMsg ==~ /(?s).*\[child-upgrade\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*child-upgrade.*/) {
+        deployChild = true
+        upgradeChild = true
+    }
+    if (commitMsg ==~ /(?s).*\[mgmt-upgrade\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*mgmt-upgrade.*/) {
+        upgradeMgmt = true
+    }
+    if (commitMsg ==~ /(?s).*\[ui-e2e\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*ui-e2e.*/) {
+        runUie2e = true
+    }
+    if (commitMsg ==~ /(?s).*\[mgmt-cfm\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*mgmt-cfm.*/) {
+        runMgmtConformance = true
+    }
+    if (commitMsg ==~ /(?s).*\[child-cfm\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*child-cfm.*/) {
+        runChildConformance = true
+        deployChild = true
+    }
+    if (commitMsg ==~ /(?s).*\[fetch.*binaries\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*fetch.*binaries.*/) {
+        fetchServiceBinaries = true
+    }
+    if (commitMsg ==~ /(?s).*\[aws-demo\].*/ || env.GERRIT_EVENT_COMMENT_TEXT ==~ /(?s).*aws-demo.*/) {
+        awsOnDemandDemo = true
+        common.warningMsg('Forced running additional kaas deployment with AWS provider, triggered on patchset using custom keyword: \'aws-demo\' ')
+    }
+
+    // TODO (vnaumov) remove below condition after moving all releases to UCP
+    def ucpChildMatches = (commitMsg =~ /(\[child-ucp\s*ucp-.*?\])/)
+    if (ucpChildMatches.size() > 0) {
+        deployChild = true
+        common.warningMsg('Forced UCP based child deployment triggered on patchset using custom keyword: \'[child-ucp ucp-5-1-0-3-3-0-example]\' ')
+
+        // TODO(vnaumov) delete after ucp upgrades support
+        common.errorMsg('Child upgrade test will be skipped, UCP upgrades temporally disabled')
+        upgradeChild = false
+    }
+
+    common.infoMsg("""
+        Child cluster deployment scheduled: ${deployChild}
+        Child cluster release upgrade scheduled: ${upgradeChild}
+        Child conformance testing scheduled: ${runChildConformance}
+        Mgmt cluster release upgrade scheduled: ${upgradeMgmt}
+        Mgmt conformance testing scheduled: ${runMgmtConformance}
+        Mgmt UI e2e testing scheduled: ${runUie2e}
+        AWS provider additional deployment scheduled: ${awsOnDemandDemo}
+        Service binaries fetching scheduled: ${fetchServiceBinaries}
+        Triggers: https://gerrit.mcp.mirantis.com/plugins/gitiles/kaas/core/+/refs/heads/master/.git-message-template#50""")
+    return [
+        deployChildEnabled: deployChild,
+        upgradeChildEnabled: upgradeChild,
+        runChildConformanceEnabled: runChildConformance,
+        upgradeMgmtEnabled: upgradeMgmt,
+        runUie2eEnabled: runUie2e,
+        runMgmtConformanceEnabled: runMgmtConformance,
+        fetchServiceBinariesEnabled: fetchServiceBinaries,
+        awsOnDemandDemoEnabled: awsOnDemandDemo]
+}
+
+/**
+ * Determine if custom si tests/pipelines refspec forwarded from gerrit change request
+
+ * Keyword list: https://gerrit.mcp.mirantis.com/plugins/gitiles/kaas/core/+/refs/heads/master/.git-message-template#59
+ * Used for components team to test component changes w/ custom SI refspecs using kaas/core deployment jobs
+ * Example scheme:
+ * New CR pushed in kubernetes/lcm-ansible -> parsing it's commit body and get custom test refspecs -> trigger deployment jobs from kaas/core
+ * manage refspecs through Jenkins Job Parameters
+ *
+ * @return        (map)[
+ *                    siTests: (string) final refspec for si-tests
+ *                    siPipelines: (string) final refspec for si-pipelines
+ *                   ]
+ */
+def checkCustomSIRefspec() {
+    // Available triggers and its sane defaults
+    def siTestsRefspec = (env.SI_TESTS_REFSPEC != null ) ? env.SI_TESTS_REFSPEC : 'master'
+    def siPipelinesRefspec = (env.SI_PIPELINES_REFSPEC != null ) ? env.SI_PIPELINES_REFSPEC : 'master'
+    def commitMsg = (env.GERRIT_CHANGE_COMMIT_MESSAGE != null) ? new String(env.GERRIT_CHANGE_COMMIT_MESSAGE.decodeBase64()) : ''
+
+    def siTestMatches = (commitMsg =~ /(\[si-tests-ref\s*refs\/changes\/.*?\])/)
+    def siPipelinesMatches = (commitMsg =~ /(\[si-pipelines-ref\s*refs\/changes\/.*?\])/)
+
+    if (siTestMatches.size() > 0) {
+        siTestsRefspec = siTestMatches[0][0].split('si-tests-ref')[1].replaceAll('[\\[\\]]', '').trim()
+    }
+    if (siPipelinesMatches.size() > 0) {
+        siPipelinesRefspec = siPipelinesMatches[0][0].split('si-pipelines-ref')[1].replaceAll('[\\[\\]]', '').trim()
+    }
+
+    common.infoMsg("""
+        kaas/si-pipelines will be fetched from: ${siPipelinesRefspec}
+        kaas/si-tests will be fetched from: ${siTestsRefspec}
+        Keywords: https://gerrit.mcp.mirantis.com/plugins/gitiles/kaas/core/+/refs/heads/master/.git-message-template#59""")
+    return [siTests: siTestsRefspec, siPipelines: siPipelinesRefspec]
+}