mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
604c6dd528
This commit creates a new Gradle plugin to provide a separate task name and source set for running YAML based REST tests. The only project converted to use the new plugin in this PR is distribution/archives/integ-test-zip. For which the testing has been moved to :rest-api-spec since it makes the most sense and it avoids a small but awkward change to the distribution plugin. The remaining cases in modules, plugins, and x-pack will be handled in followups. This plugin is distinctly different from the plugin introduced in #55896 since the YAML REST tests are intended to be black box tests over HTTP. As such they should not (by default) have access to the classpath for that which they are testing. The YAML based REST tests will be moved to separate source sets (yamlRestTest). The which source is the target for the test resources is dependent on if this new plugin is applied. If it is not applied, it will default to the test source set. Further, this introduces a breaking change for plugin developers that use the YAML testing framework. They will now need to either use the new source set and matching task, or configure the rest resources to use the old "test" source set that matches the old integTest task. (The former should be preferred). As part of this change (which is also breaking for plugin developers) the rest resources plugin has been removed from the build plugin and now requires either explicit application or application via the new YAML REST test plugin. Plugin developers should be able to fix the breaking changes to the YAML tests by adding apply plugin: 'elasticsearch.yaml-rest-test' and moving the YAML tests under a yamlRestTest folder (instead of test)
95 lines
3.6 KiB
Groovy
95 lines
3.6 KiB
Groovy
import groovy.json.JsonSlurper
|
|
|
|
import javax.net.ssl.HttpsURLConnection
|
|
import java.nio.charset.StandardCharsets
|
|
|
|
apply plugin: 'elasticsearch.testclusters'
|
|
apply plugin: 'elasticsearch.standalone-rest-test'
|
|
apply plugin: 'elasticsearch.rest-test'
|
|
apply plugin: 'elasticsearch.rest-resources'
|
|
|
|
dependencies {
|
|
testImplementation project(':x-pack:plugin:core')
|
|
testImplementation project(path: xpackModule('watcher'))
|
|
}
|
|
|
|
restResources {
|
|
restApi {
|
|
includeXpack 'watcher'
|
|
}
|
|
}
|
|
|
|
String jiraUrl = System.getenv('jira_url')
|
|
String jiraUser = System.getenv('jira_user')
|
|
String jiraPassword = System.getenv('jira_password')
|
|
String jiraProject = System.getenv('jira_project')
|
|
|
|
task cleanJira(type: DefaultTask) {
|
|
doLast {
|
|
List<String> issues = jiraIssues(jiraProject)
|
|
assert issues instanceof List
|
|
issues.forEach {
|
|
// See https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-deleteIssue
|
|
logger.debug("Deleting JIRA issue [${it}]")
|
|
jiraHttpRequest("issue/${it}", "DELETE", 204)
|
|
}
|
|
}
|
|
}
|
|
|
|
// require network access for this one, exit early instead of starting up the cluster if we dont have network
|
|
if (!jiraUrl && !jiraUser && !jiraPassword && !jiraProject) {
|
|
integTest.enabled = false
|
|
testingConventions.enabled = false
|
|
} else {
|
|
testClusters.integTest {
|
|
testDistribution = 'DEFAULT'
|
|
setting 'xpack.security.enabled', 'false'
|
|
setting 'xpack.ml.enabled', 'false'
|
|
setting 'xpack.license.self_generated.type', 'trial'
|
|
setting 'logger.org.elasticsearch.xpack.watcher', 'DEBUG'
|
|
setting 'xpack.notification.jira.account.test.issue_defaults.issuetype.name', 'Bug'
|
|
setting 'xpack.notification.jira.account.test.issue_defaults.labels.0', 'integration-tests'
|
|
setting 'xpack.notification.jira.account.test.issue_defaults.project.key', jiraProject
|
|
keystore 'xpack.notification.jira.account.test.secure_url', jiraUrl
|
|
keystore 'xpack.notification.jira.account.test.secure_user', jiraUser
|
|
keystore 'xpack.notification.jira.account.test.secure_password', jiraPassword
|
|
}
|
|
integTest.runner.finalizedBy cleanJira
|
|
}
|
|
|
|
/** List all issues associated to a given Jira project **/
|
|
def jiraIssues(projectKey) {
|
|
// See https://docs.atlassian.com/jira/REST/cloud/#api/2/search-search
|
|
def response = jiraHttpRequest("search?maxResults=100&fields=id,self,key&jql=project%3D${projectKey}", "GET", 200)
|
|
assert response.issues instanceof List
|
|
return response.issues.findAll { it.key.startsWith(projectKey) }.collect { it.key }
|
|
}
|
|
|
|
/** Execute an HTTP request against the Jira server instance **/
|
|
def jiraHttpRequest(String endpoint, String method, int successCode) {
|
|
HttpsURLConnection connection = null;
|
|
try {
|
|
byte[] credentials = "${jiraUser}:${jiraPassword}".getBytes(StandardCharsets.UTF_8);
|
|
connection = (HttpsURLConnection) new URL("${jiraUrl}/rest/api/2/${endpoint}").openConnection();
|
|
connection.setRequestProperty("Authorization", "Basic " + Base64.getEncoder().encodeToString(credentials));
|
|
connection.setRequestMethod(method);
|
|
connection.connect();
|
|
|
|
if (connection.getResponseCode() == successCode) {
|
|
String response = connection.getInputStream().getText(StandardCharsets.UTF_8.name());
|
|
if (response != null && response.length() > 0) {
|
|
return new JsonSlurper().parseText(response)
|
|
}
|
|
} else {
|
|
throw new GradleException("Unexpected response code for [${endpoint}]: got ${connection.getResponseCode()} but expected ${successCode}")
|
|
}
|
|
} catch (Exception e) {
|
|
logger.error("Failed to delete JIRA issues after test execution", e)
|
|
} finally {
|
|
if (connection != null) {
|
|
connection.disconnect();
|
|
}
|
|
}
|
|
return null
|
|
}
|