... Currently, Java version detection is incorporated so that Java tools can be run reliably.
... Also, suport for installing and running Maven is added, as that needs the Java detection.
... TODO: Move Java detection and Maven to a separate Resource, or rename this Resource.
+Library Collections
Library OperatingSystem
Library SSHLibrary
Library String
-Resource SSHKeywords.robot
+Library XML
+Library Collections
+Library RequestsLibrary
+Resource ${CURDIR}/CompareStream.robot
+Resource ${CURDIR}/SSHKeywords.robot
+Resource ${CURDIR}/Utils.robot
*** Variables ***
+&{COMPONENT_MAPPING} netconf=netconf-impl bgpcep=pcep-impl carpeople=clustering-it-model yangtools=yang-data-impl bindingv1=mdsal-binding-generator-impl odl-micro=odlmicro-impl
+@{RELEASE_INTEGRATED_COMPONENTS} mdsal odlparent yangtools carpeople netconf bgpcep
${JDKVERSION} None
-${JAVA_7_HOME_CENTOS} /usr/lib/jvm/java-1.7.0
-${JAVA_7_HOME_UBUNTU} /usr/lib/jvm/java-7-openjdk-amd64
${JAVA_8_HOME_CENTOS} /usr/lib/jvm/java-1.8.0
${JAVA_8_HOME_UBUNTU} /usr/lib/jvm/java-8-openjdk-amd64
+${JAVA_11_HOME_CENTOS} /usr/lib/jvm/java-11-openjdk
+${JAVA_11_HOME_UBUNTU} /usr/lib/jvm/java-11-openjdk-amd64
${JAVA_OPTIONS} -Xmx2560m # Note that '-Xmx=3g' is wrong syntax. Also 3GB heap may not fit in 4GB RAM.
-${JAVA_7_OPTIONS} -Xmx2048m -XX:MaxPermSize=512m
${MAVEN_DEFAULT_OUTPUT_FILENAME} default_maven.log
-${MAVEN_OPTIONS} -Pq -Djenkins
+${MAVEN_OPTIONS} -Pq -Djenkins
${MAVEN_REPOSITORY_PATH} /tmp/r
${MAVEN_SETTINGS_URL} https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
${MAVEN_VERSION} 3.3.9
${NEXUS_FALLBACK_URL} ${NEXUSURL_PREFIX}/content/repositories/opendaylight.snapshot
+${NEXUS_RELEASE_BASE_URL} https://nexus.opendaylight.org/content/repositories/opendaylight.release
+${NEXUS_RELEASES_URL} ${NEXUS_RELEASE_BASE_URL}/org/opendaylight/integration/karaf
*** Keywords ***
Initialize_Artifact_Deployment_And_Usage
NexusKeywords__Get_Items_To_Look_At
[Arguments] ${component}
[Documentation] Get a list of items that might contain the version number that we are looking for.
- BuiltIn.Return_From_Keyword_If '${component}' == 'bgpcep' pcep-impl
- [Return] ${component}-impl
+ ...
+ ... &{COMPONENT_MAPPING} is the centralized place to maintain the mapping
+ ... from a stream independent component nickname to the list of artifact names to search for.
+ Collections.Dictionary_Should_Contain_Key ${COMPONENT_MAPPING} ${component} Component not supported by NexusKeywords version detection: ${component}
+ BuiltIn.Run_Keyword_And_Return Collections.Get_From_Dictionary ${COMPONENT_MAPPING} ${component}
NexusKeywords__Detect_Version_To_Pull
[Arguments] ${component}
SSHKeywords.Open_Connection_To_ODL_System
${version} ${result} = SSHLibrary.Execute_Command sh search.sh ${WORKSPACE}/${BUNDLEFOLDER}/system ${itemlist} return_rc=True
SSHLibrary.Close_Connection
- Restore Current SSH Connection From Index ${current_ssh_connection.index}
+ SSHKeywords.Restore Current SSH Connection From Index ${current_ssh_connection.index}
BuiltIn.Log ${version}
- BuiltIn.Run_Keyword_If ${result}!=0 BuiltIn.Fail Component "${component}" not found, cannot locate test tool
+ BuiltIn.Run_Keyword_If ${result}!=0 BuiltIn.Fail Component "${component}": searching for "${itemlist}" found no version, cannot locate test tool.
${version} ${location} = String.Split_String ${version} max_split=1
[Return] ${version} ${location}
+Deploy_From_Url
+ [Arguments] ${url}
+ [Documentation] On active SSH conenction execute download ${url} command, log output, check RC and return file name.
+ ${filename} = String.Fetch_From_Right ${url} /
+ ${response} ${result} = SSHLibrary.Execute_Command wget -q -N '${url}' 2>&1 return_rc=True
+ BuiltIn.Log ${response}
+ BuiltIn.Run_Keyword_If ${result} != 0 BuiltIn.Fail File ${filename} could not be downloaded from ${url}
+ [Return] ${filename}
+
Deploy_Artifact
- [Arguments] ${component} ${artifact} ${name_prefix} ${name_suffix}=-executable.jar ${fallback_url}=${NEXUS_FALLBACK_URL}
+ [Arguments] ${component} ${artifact} ${name_prefix}=${artifact}- ${name_suffix}=-executable.jar ${fallback_url}=${NEXUS_FALLBACK_URL} ${explicit_url}=${EMPTY} ${build_version}=${EMPTY} ${build_location}=${EMPTY}
[Documentation] Deploy the specified artifact from Nexus to the cwd of the machine to which the active SSHLibrary connection points.
+ ... ${component} is a name part of an artifact present in system/ of ODl installation with the same version as ${artifact} should have.
... Must have ${BUNDLE_URL} variable set to the URL from which the
... tested ODL distribution was downloaded and this place must be
... inside a repository created by a standard distribution
... construction job. If this is detected to ne be the case, fallback URL is used.
+ ... If ${explicit_url} is non-empty, Deploy_From_Utrl is called instead.
+ ... TODO: Allow deploying to a specific directory, we have SSHKeywords.Execute_Command_At_Cwd_Should_Pass now.
+ BuiltIn.Run_Keyword_And_Return_If """${explicit_url}""" != "" Deploy_From_Url ${explicit_url}
${urlbase} = String.Fetch_From_Left ${BUNDLE_URL} /org/opendaylight
# If the BUNDLE_URL points somewhere else (perhaps *patch-test* job in Jenkins),
# ${urlbase} is the whole ${BUNDLE_URL}, in which case we use the ${fallback_url}
+ # If we are working with a "release integrated" project, we always will want to look for
+ # a released version, not in the snapshots
${urlbase} = BuiltIn.Set_Variable_If '${urlbase}' != '${BUNDLE_URL}' ${urlbase} ${fallback_url}
- ${version} ${location} = NexusKeywords__Detect_Version_To_Pull ${component}
+ CompareStream.Run_Keyword_If_At_Most_Magnesium Collections.Remove_Values_From_List ${RELEASE_INTEGRATED_COMPONENTS} carpeople
+ CompareStream.Run_Keyword_If_At_Most_Aluminium Collections.Remove_Values_From_List ${RELEASE_INTEGRATED_COMPONENTS} netconf
+ CompareStream.Run_Keyword_If_At_Most_Silicon Collections.Remove_Values_From_List ${RELEASE_INTEGRATED_COMPONENTS} bgpcep
+ ${version} ${location} = BuiltIn.Run_Keyword_If '${build_version}'=='${EMPTY}' NexusKeywords__Detect_Version_To_Pull ${component}
+ ... ELSE BuiltIn.Set_Variable ${build_version} ${build_location}
+ BuiltIn.Run_Keyword_If 'SNAPSHOT' in '${version}' Collections.Remove_Values_From_List ${RELEASE_INTEGRATED_COMPONENTS} netconf bgpcep
+ # check if the bundle url is pointing to a staging artifact
+ # when we are pointing at a staged artifact we need to use the staging repo instead of release/snapshot artifacts
+ ${is_staged} = BuiltIn.Set_Variable_If "opendaylight.release" not in '${urlbase}' and "opendaylight.snapshot" not in '${urlbase}' "TRUE" "FALSE"
+ # if we have a staged artifact we need to use the urlbase given to us in the job params
+ ${is_mri_component} = BuiltIn.Set_Variable_If '${component}' in ${RELEASE_INTEGRATED_COMPONENTS} "TRUE" "FALSE"
+ ${urlbase} = BuiltIn.Set_Variable_If ${is_mri_component} == "TRUE" and ${is_staged} == "FALSE" ${NEXUS_RELEASE_BASE_URL} ${urlbase}
# TODO: Use RequestsLibrary and String instead of curl and bash utilities?
${url} = BuiltIn.Set_Variable ${urlbase}/${location}/${artifact}/${version}
- ${namepart} = SSHLibrary.Execute_Command curl -L ${url}/maven-metadata.xml | grep value | head -n 1 | cut -d '>' -f 2 | cut -d '<' -f 1
- BuiltIn.Log ${namepart}
+ # TODO: Review SSHKeywords for current best keywords to call.
+ ${metadata} = SSHKeywords.Execute_Command_Should_Pass curl -L ${url}/maven-metadata.xml
+ ${status} ${namepart} = BuiltIn.Run_Keyword_And_Ignore_Error SSHKeywords.Execute_Command_Should_Pass echo "${metadata}" | grep value | head -n 1 | cut -d '>' -f 2 | cut -d '<' -f 1 stderr_must_be_empty=${True}
${length} = BuiltIn.Get_Length ${namepart}
- ${namepart} = BuiltIn.Set_Variable_If ${length} == 0 ${version} ${namepart}
+ ${namepart} = BuiltIn.Set_Variable_If "${status}" != "PASS" or ${length} == 0 ${version} ${namepart}
${filename} = BuiltIn.Set_Variable ${name_prefix}${namepart}${name_suffix}
BuiltIn.Log ${filename}
${url} = BuiltIn.Set_Variable ${url}/${filename}
- ${response} ${result} = SSHLibrary.Execute_Command wget -q -N ${url} 2>&1 return_rc=True
+ ${response} ${result} = SSHLibrary.Execute_Command wget -q -N '${url}' 2>&1 return_rc=True
BuiltIn.Log ${response}
- BuiltIn.Run_Keyword_If ${result} != 0 BuiltIn.Fail Artifact "${artifact}" in component "${component}" could not be downloaded from ${url}
+ BuiltIn.Return_From_Keyword_If ${result} == 0 ${filename}
+ # staged autorelease for non-mri project might not contain the artifact we need so we need to fallback to grabbing it from the release repo
+ ${release_url} = String.Replace_String_Using_Regexp ${url} autorelease-[0-9]{4} opendaylight.release
+ ${response} ${result} = SSHLibrary.Execute_Command wget -q -N '${release_url}' 2>&1 return_rc=True
+ BuiltIn.Run_Keyword_If ${result} != 0 BuiltIn.Fail Artifact "${artifact}" in component "${component}" could not be downloaded from ${release_url} nor ${url}
[Return] ${filename}
Deploy_Test_Tool
- [Arguments] ${component} ${artifact} ${suffix}=executable
+ [Arguments] ${component} ${artifact} ${suffix}=executable ${fallback_url}=${NEXUS_FALLBACK_URL} ${explicit_url}=${EMPTY} ${build_version}=${EMPTY} ${build_location}=${EMPTY}
[Documentation] Deploy a test tool.
... The test tools have naming convention of the form
... "<repository_url>/some/dir/somewhere/<tool-name>/<tool-name>-<version-tag>-${suffix}.jar"
... "Deploy_Artifact" and then calls "Deploy_Artifact" to do the real
... work of deploying the artifact.
${name_prefix} = BuiltIn.Set_Variable ${artifact}-
- ${name_suffix} = BuiltIn.Set_Variable -${suffix}.jar
- ${filename} = Deploy_Artifact ${component} ${artifact} ${name_prefix} ${name_suffix}
+ ${extension} = BuiltIn.Set_Variable_If '${component}'=='odl-micro' tar jar
+ ${name_suffix} = BuiltIn.Set_Variable_If "${suffix}" != "" -${suffix}.${extension} .${extension}
+ ${filename} = Deploy_Artifact ${component} ${artifact} ${name_prefix} ${name_suffix} ${fallback_url}
+ ... ${explicit_url} ${build_version} ${build_location}
[Return] ${filename}
+Install_And_Start_Java_Artifact
+ [Arguments] ${component} ${artifact} ${suffix}=executable ${tool_options}=${EMPTY} ${java_options}=${EMPTY} ${openjdk}=${JDKVERSION}
+ ... ${fallback_url}=${NEXUS_FALLBACK_URL} ${explicit_url}=${EMPTY}
+ [Documentation] Deploy the artifact, assign name for log file, figure out java command, write the command to active SSH connection and return the log name.
+ ... This keyword does not examine whether the artifact was started successfully or whether is still running upon return.
+ # TODO: Unify this keyword with what NexusKeywords.Install_And_Start_Testtool does.
+ ${actual_java_options} = BuiltIn.Set_Variable_If """${java_options}""" != "" ${java_options} ${JAVA_OPTIONS}
+ ${filename} = Deploy_Test_Tool ${component} ${artifact} ${suffix} ${fallback_url} ${explicit_url}
+ ${command} = Compose_Full_Java_Command ${actual_java_options} -jar ${filename} ${tool_options}
+ ${logfile} = Utils.Get_Log_File_Name ${artifact}
+ SSHLibrary.Write ${command} >${logfile} 2>&1
+ [Return] ${logfile}
+
Compose_Dilemma_Filepath
[Arguments] ${default_path} ${specific_path}
[Documentation] Query active SSH connection, return specific path if it exists else default path.
... Not directly related to Nexus, but versioned Java tools may need this.
# Check whether the user set the override and return it if yes.
BuiltIn.Run_Keyword_And_Return_If """${openjdk}""" == "openjdk8" Compose_Dilemma_Filepath ${JAVA_8_HOME_CENTOS}/bin/java ${JAVA_8_HOME_UBUNTU}/bin/java
- BuiltIn.Run_Keyword_And_Return_If """${openjdk}""" == "openjdk7" Compose_Dilemma_Filepath ${JAVA_7_HOME_CENTOS}/bin/java ${JAVA_7_HOME_UBUNTU}/bin/java
+ BuiltIn.Run_Keyword_And_Return_If """${openjdk}""" == "openjdk11" Compose_Dilemma_Filepath ${JAVA_11_HOME_CENTOS}/bin/java ${JAVA_11_HOME_UBUNTU}/bin/java
# Attempt to call plain "java" command directly. If it works, return it.
${out} ${rc} = SSHLibrary.Execute_Command java -version 2>&1 return_rc=True
BuiltIn.Return_From_Keyword_If ${rc} == 0 java
# Query the virtual machine for the JAVA_HOME environment variable and
# use it to assemble a (hopefully) working command. If that worked out,
# return the result.
- ${java} = SSHLibrary.Execute_Command echo \$JAVA_HOME/bin/java 2>&1
+ ${java} = SSHLibrary.Execute_Command echo $JAVA_HOME/bin/java 2>&1
${out} ${rc} = SSHLibrary.Execute_Command ${java} -version 2>&1 return_rc=True
BuiltIn.Return_From_Keyword_If ${rc} == 0 ${java}
# There are bizzare test environment setups where the (correct) JAVA_HOME
SSHKeywords.Execute_Command_At_Cwd_Should_Pass wget -N '${maven_download_url}' stderr_must_be_empty=False
SSHKeywords.Execute_Command_At_Cwd_Should_Pass tar xvf '${maven_archive_filename}'
${java_home} = NexusKeywords.Compose_Java_Home openjdk=${openjdk}
- ${java_actual_options} = BuiltIn.Set_Variable_If """${openjdk}""" == "openjdk7" ${JAVA_7_OPTIONS} ${JAVA_OPTIONS}
- BuiltIn.Set_Global_Variable \${maven_bash_command} export JAVA_HOME='${java_home}' && export MAVEN_OPTS='${java_actual_options}' && ./${maven_directory}/bin/mvn
+ BuiltIn.Set_Global_Variable \${maven_bash_command} export JAVA_HOME='${java_home}' && export MAVEN_OPTS='${JAVA_OPTIONS}' && ./${maven_directory}/bin/mvn
# TODO: Get settings files from Jenkins settings provider, somehow.
SSHKeywords.Execute_Command_At_Cwd_Should_Pass wget '${MAVEN_SETTINGS_URL}' -O settings.xml stderr_must_be_empty=False
SSHKeywords.Execute_Command_At_Cwd_Should_Pass mkdir -p '${MAVEN_REPOSITORY_PATH}'
${maven_repository_options} = BuiltIn.Set_Variable -Dmaven.repo.local=${MAVEN_REPOSITORY_PATH} -Dorg.ops4j.pax.url.mvn.localRepository=${MAVEN_REPOSITORY_PATH}
SSHKeywords.Execute_Command_At_Cwd_Should_Pass ${maven_bash_command} clean install dependency:tree -V -B -DoutputFile=dependency_tree.log -s './settings.xml' -f '${pom_file}' ${MAVEN_OPTIONS} ${maven_repository_options} > '${log_file}'
+
+Get_ODL_Versions_From_Nexus
+ [Documentation] Returns name of last release found on nexus and list of all versions.
+ RequestsLibrary.Create_Session nexus ${NEXUS_RELEASES_URL} verify=${TRUE}
+ ${uri}= BuiltIn.Set_Variable maven-metadata.xml
+ ${response}= RequestsLibrary.Get_Request nexus ${uri}
+ BuiltIn.Log ${response.text}
+ ${root}= XML.Parse_XML ${response.text}
+ ${element}= XML.Get_Element ${root} versioning/latest
+ ${latest}= BuiltIn.Set_Variable ${element.text}
+ BuiltIn.Log ${latest}
+ @{elements}= XML.Get_Elements ${root} .//version
+ ${versions}= BuiltIn.Create_List
+ FOR ${element} IN @{elements}
+ BuiltIn.Run_Keyword_If 'Carbon' not in $element.text Collections.Append_To_List ${versions} ${element.text}
+ END
+ Collections.Sort_List ${versions}
+ BuiltIn.Log_Many @{versions}
+ [Return] ${latest} @{versions}
+
+Get_Latest_ODL_Release_From_Nexus
+ [Documentation] Returns name of last release found on nexus
+ ${latest} @{versions}= Get_ODL_Versions_From_Nexus
+ [Return] ${latest}
+
+Get_Latest_ODL_Stream_Release
+ [Arguments] ${stream}=latest
+ [Documentation] Returns name for last release for specified stream.
+ ${latest} @{versions}= Get_ODL_Versions_From_Nexus
+ BuiltIn.Return_From_Keyword_If '${stream}'=='latest' ${latest}
+ ${latest_version}= BuiltIn.Set_Variable xxx
+ FOR ${version} IN @{versions}
+ ${latest_version}= BuiltIn.Set_Variable_If '${stream}'.title() in '${version}' ${version} ${latest_version}
+ END
+ BuiltIn.Run_Keyword_If '${latest_version}'=='xxx' BuiltIn.Fail Could not find latest release for stream ${stream}
+ BuiltIn.Log ${latest_version}
+ [Return] ${latest_version}
+
+Get_Latest_ODL_Stream_Release_URL
+ [Arguments] ${stream}=latest ${format}=.zip
+ [Documentation] Returns URL for last release for specified stream. Default format is .zip.
+ ${latest_version}= Get_Latest_ODL_Stream_Release ${stream}
+ ${url}= BuiltIn.Set_Variable ${NEXUS_RELEASES_URL}/${latest_version}/karaf-${latest_version}${format}
+ BuiltIn.Log ${url}
+ [Return] ${url}
+
+Get_Latest_ODL_Previous_Stream_Release
+ [Arguments] ${stream}=${ODL_STREAM}
+ [Documentation] Returns name for last release for previous stream of specified stream.
+ ... Note: If specified stream is not found on nexus, then it is taken as new one (not released yet).
+ ... So in this case, latest release version is return.
+ ...
+ ... NOTE: the below logic is stripping the initial 0. values from the 0.x.x version string that is
+ ... the current (and future) version numbering scheme. There is always a leading 0. to the version
+ ... strings and stripping it makes is easier to do int comparison to find the largest version in the
+ ... list. Comparing as strings does not work. There are some python libs like distutils.version
+ ... or packaging that can do a better job comparing versions, but since ODL version numbering is simple
+ ... at this point, this convention will suffice. The leading 0. will be added back after the the latest
+ ... version is found from the list. The CompareStream.robot library keeps a mapping of major version
+ ... numbers to the global variable ${ODL_STREAM} so that is used to ensure we get a major version that is
+ ... older than the current running major version.
+ ${latest} @{versions}= Get_ODL_Versions_From_Nexus
+ ${current_version}= BuiltIn.Set_Variable ${Stream_dict}[${ODL_STREAM}].0
+ ${latest_version}= BuiltIn.Set_Variable 0.0
+ FOR ${version} IN @{versions}
+ ${version} = String.Replace String Using Regexp ${version} ^0\. ${EMPTY}
+ ${latest_version}= Set Variable If ${version} > ${latest_version} and ${version} < ${current_version} ${version} ${latest_version}
+ END
+ ${latest_version}= Set Variable 0.${latest_version}
+ BuiltIn.Run_Keyword_If '${latest_version}'=='0.0.0' BuiltIn.Fail Could not find latest previous release for stream ${stream}
+ BuiltIn.Log ${latest_version}
+ [Return] ${latest_version}
+
+Get_Latest_ODL_Previous_Stream_Release_URL
+ [Arguments] ${stream}=${ODL_STREAM} ${format}=.zip
+ [Documentation] Returns URL for last release for previous stream of specified stream. Default format is .zip.
+ ${latest_version}= Get_Latest_ODL_Previous_Stream_Release ${stream}
+ ${url}= BuiltIn.Set_Variable ${NEXUS_RELEASES_URL}/${latest_version}/karaf-${latest_version}${format}
+ BuiltIn.Log ${url}
+ [Return] ${url}
Code Review / integration / test.git / blobdiff