2 Documentation Nexus repository access keywords, and supporting Java and Maven handling.
4 ... Copyright (c) 2015,2016 Cisco Systems, Inc. and others. All rights reserved.
6 ... This program and the accompanying materials are made available under the
7 ... terms of the Eclipse Public License v1.0 which accompanies this distribution,
8 ... and is available at http://www.eclipse.org/legal/epl-v10.html
11 ... This library encapsulates a bunch of somewhat complex and commonly used
12 ... Nexus operations into reusable keywords to make writing test suites easier.
14 ... Currently, Java version detection is incorporated so that Java tools can be run reliably.
15 ... Also, suport for installing and running Maven is added, as that needs the Java detection.
16 ... TODO: Move Java detection and Maven to a separate Resource, or rename this Resource.
18 Library OperatingSystem
23 Library RequestsLibrary
24 Resource ${CURDIR}/SSHKeywords.robot
25 Resource ${CURDIR}/Utils.robot
28 &{COMPONENT_MAPPING} netconf=netconf-impl bgpcep=pcep-impl carpeople=clustering-it-model yangtools=yang-data-impl bindingv1=mdsal-binding-generator-impl
30 ${JAVA_7_HOME_CENTOS} /usr/lib/jvm/java-1.7.0
31 ${JAVA_7_HOME_UBUNTU} /usr/lib/jvm/java-7-openjdk-amd64
32 ${JAVA_8_HOME_CENTOS} /usr/lib/jvm/java-1.8.0
33 ${JAVA_8_HOME_UBUNTU} /usr/lib/jvm/java-8-openjdk-amd64
34 ${JAVA_11_HOME_CENTOS} /usr/lib/jvm/java-11-openjdk
35 ${JAVA_11_HOME_UBUNTU} /usr/lib/jvm/java-11-openjdk-amd64
36 ${JAVA_OPTIONS} -Xmx2560m # Note that '-Xmx=3g' is wrong syntax. Also 3GB heap may not fit in 4GB RAM.
37 ${JAVA_7_OPTIONS} -Xmx2048m -XX:MaxPermSize=512m
38 ${MAVEN_DEFAULT_OUTPUT_FILENAME} default_maven.log
39 ${MAVEN_OPTIONS} -Pq -Djenkins
40 ${MAVEN_REPOSITORY_PATH} /tmp/r
41 ${MAVEN_SETTINGS_URL} https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
42 ${MAVEN_VERSION} 3.3.9
43 ${NEXUS_FALLBACK_URL} ${NEXUSURL_PREFIX}/content/repositories/opendaylight.snapshot
44 ${NEXUS_RELEASE_BASE_URL} https://nexus.opendaylight.org/content/repositories/opendaylight.release
45 ${NEXUS_RELEASES_URL} ${NEXUS_RELEASE_BASE_URL}/org/opendaylight/integration/distribution-karaf
48 Initialize_Artifact_Deployment_And_Usage
49 [Arguments] ${tools_system_connect}=True
50 [Documentation] Places search utility to ODL system, which will be needed for version detection.
51 ... By default also initialize a SSH connection to Tools system,
52 ... as following Keywords assume a working connection towards target system.
53 # Connect to the ODL machine.
54 ${odl} = SSHKeywords.Open_Connection_To_ODL_System
55 # Deploy the search tool.
56 SSHLibrary.Put_File ${CURDIR}/../../tools/deployment/search.sh
57 SSHLibrary.Close_Connection
58 # Optionally connect to the Tools System machine.
59 BuiltIn.Return_From_Keyword_If not (${tools_system_connect}) # the argument may be a convoluted Python expression
60 SSHKeywords.Open_Connection_To_Tools_System
62 NexusKeywords__Get_Items_To_Look_At
63 [Arguments] ${component}
64 [Documentation] Get a list of items that might contain the version number that we are looking for.
66 ... &{COMPONENT_MAPPING} is the centralized place to maintain the mapping
67 ... from a stream independent component nickname to the list of artifact names to search for.
68 Collections.Dictionary_Should_Contain_Key ${COMPONENT_MAPPING} ${component} Component not supported by NexusKeywords version detection: ${component}
69 BuiltIn.Run_Keyword_And_Return Collections.Get_From_Dictionary ${COMPONENT_MAPPING} ${component}
71 NexusKeywords__Detect_Version_To_Pull
72 [Arguments] ${component}
73 [Documentation] Determine the exact Nexus directory to be used as a source for a particular test tool
74 ... Figure out what version of the tool needs to be pulled out of the
75 ... Nexus by looking at the version directory of the subsystem from
76 ... which the tool is being pulled. This code is REALLY UGLY but there
77 ... is no way around it until the bug
78 ... https://bugs.opendaylight.org/show_bug.cgi?id=5206 gets fixed.
79 ... I also don't want to depend on maven-metadata-local.xml and other
80 ... bits and pieces of ODL distribution which are not required for ODL
81 ... to function properly.
82 ${itemlist} = NexusKeywords__Get_Items_To_Look_At ${component}
83 ${current_ssh_connection} = SSHLibrary.Get Connection
84 SSHKeywords.Open_Connection_To_ODL_System
85 ${version} ${result} = SSHLibrary.Execute_Command sh search.sh ${WORKSPACE}/${BUNDLEFOLDER}/system ${itemlist} return_rc=True
86 SSHLibrary.Close_Connection
87 SSHKeywords.Restore Current SSH Connection From Index ${current_ssh_connection.index}
88 BuiltIn.Log ${version}
89 BuiltIn.Run_Keyword_If ${result}!=0 BuiltIn.Fail Component "${component}": searching for "${itemlist}" found no version, cannot locate test tool.
90 ${version} ${location} = String.Split_String ${version} max_split=1
91 [Return] ${version} ${location}
95 [Documentation] On active SSH conenction execute download ${url} command, log output, check RC and return file name.
96 ${filename} = String.Fetch_From_Right ${url} /
97 ${response} ${result} = SSHLibrary.Execute_Command wget -q -N '${url}' 2>&1 return_rc=True
98 BuiltIn.Log ${response}
99 BuiltIn.Run_Keyword_If ${result} != 0 BuiltIn.Fail File ${filename} could not be downloaded from ${url}
103 [Arguments] ${component} ${artifact} ${name_prefix}=${artifact}- ${name_suffix}=-executable.jar ${fallback_url}=${NEXUS_FALLBACK_URL} ${explicit_url}=${EMPTY}
104 [Documentation] Deploy the specified artifact from Nexus to the cwd of the machine to which the active SSHLibrary connection points.
105 ... ${component} is a name part of an artifact present in system/ of ODl installation with the same version as ${artifact} should have.
106 ... Must have ${BUNDLE_URL} variable set to the URL from which the
107 ... tested ODL distribution was downloaded and this place must be
108 ... inside a repository created by a standard distribution
109 ... construction job. If this is detected to ne be the case, fallback URL is used.
110 ... If ${explicit_url} is non-empty, Deploy_From_Utrl is called instead.
111 ... TODO: Allow deploying to a specific directory, we have SSHKeywords.Execute_Command_At_Cwd_Should_Pass now.
112 BuiltIn.Run_Keyword_And_Return_If """${explicit_url}""" != "" Deploy_From_Url ${explicit_url}
113 ${urlbase} = String.Fetch_From_Left ${BUNDLE_URL} /org/opendaylight
114 # If the BUNDLE_URL points somewhere else (perhaps *patch-test* job in Jenkins),
115 # ${urlbase} is the whole ${BUNDLE_URL}, in which case we use the ${fallback_url}
116 ${urlbase} = BuiltIn.Set_Variable_If '${urlbase}' != '${BUNDLE_URL}' ${urlbase} ${fallback_url}
117 ${version} ${location} = NexusKeywords__Detect_Version_To_Pull ${component}
118 # TODO: Use RequestsLibrary and String instead of curl and bash utilities?
119 ${url} = BuiltIn.Set_Variable ${urlbase}/${location}/${artifact}/${version}
120 # TODO: Review SSHKeywords for current best keywords to call.
121 ${metadata} = SSHKeywords.Execute_Command_Should_Pass curl -L ${url}/maven-metadata.xml
122 ${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}
123 ${length} = BuiltIn.Get_Length ${namepart}
124 ${namepart} = BuiltIn.Set_Variable_If "${status}" != "PASS" or ${length} == 0 ${version} ${namepart}
125 ${filename} = BuiltIn.Set_Variable ${name_prefix}${namepart}${name_suffix}
126 BuiltIn.Log ${filename}
127 ${url} = BuiltIn.Set_Variable ${url}/${filename}
128 ${response} ${result} = SSHLibrary.Execute_Command wget -q -N '${url}' 2>&1 return_rc=True
129 BuiltIn.Log ${response}
130 BuiltIn.Run_Keyword_If ${result} != 0 BuiltIn.Fail Artifact "${artifact}" in component "${component}" could not be downloaded from ${url}
134 [Arguments] ${component} ${artifact} ${suffix}=executable ${fallback_url}=${NEXUS_FALLBACK_URL} ${explicit_url}=${EMPTY}
135 [Documentation] Deploy a test tool.
136 ... The test tools have naming convention of the form
137 ... "<repository_url>/some/dir/somewhere/<tool-name>/<tool-name>-<version-tag>-${suffix}.jar"
138 ... where "<tool-name>" is the name of the tool and "<version-tag>" is
139 ... the version tag that is digged out of the maven metadata. This
140 ... keyword calculates ${name_prefix} and ${name_suffix} for
141 ... "Deploy_Artifact" and then calls "Deploy_Artifact" to do the real
142 ... work of deploying the artifact.
143 ${name_prefix} = BuiltIn.Set_Variable ${artifact}-
144 ${name_suffix} = BuiltIn.Set_Variable_If "${suffix}" != "" -${suffix}.jar .jar
145 ${filename} = Deploy_Artifact ${component} ${artifact} ${name_prefix} ${name_suffix} ${fallback_url}
149 Install_And_Start_Java_Artifact
150 [Arguments] ${component} ${artifact} ${suffix}=executable ${tool_options}=${EMPTY} ${java_options}=${EMPTY} ${openjdk}=${JDKVERSION}
151 ... ${fallback_url}=${NEXUS_FALLBACK_URL} ${explicit_url}=${EMPTY}
152 [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.
153 ... This keyword does not examine whether the artifact was started successfully or whether is still running upon return.
154 # TODO: Unify this keyword with what NexusKeywords.Install_And_Start_Testtool does.
155 ${default_java_options} = Default_Java_Options ${openjdk}
156 ${actual_java_options} = BuiltIn.Set_Variable_If """${java_options}""" != "" ${java_options} ${default_java_options}
157 ${filename} = Deploy_Test_Tool ${component} ${artifact} ${suffix} ${fallback_url} ${explicit_url}
158 ${command} = Compose_Full_Java_Command ${actual_java_options} -jar ${filename} ${tool_options}
159 ${logfile} = Utils.Get_Log_File_Name ${artifact}
160 SSHLibrary.Write ${command} >${logfile} 2>&1
163 Compose_Dilemma_Filepath
164 [Arguments] ${default_path} ${specific_path}
165 [Documentation] Query active SSH connection, return specific path if it exists else default path.
166 ${out} ${rc} = SSHLibrary.Execute_Command ls -lA ${specific_path} 2>&1 return_rc=True
167 BuiltIn.Return_From_Keyword_If ${rc} == 0 ${specific_path}
168 BuiltIn.Return_From_Keyword ${default_path}
170 Compose_Base_Java_Command
171 [Arguments] ${openjdk}=${JDKVERSION}
172 [Documentation] Return string suitable for launching Java programs over SSHLibrary, depending on JRE version needed.
173 ... This requires that the SSH connection on which the command is going to be used is active as it is needed for querying files.
174 ... Commands composed for one SSH connection shall not be reused on other SSH connections as the two connections may have different Java setups.
175 ... Not directly related to Nexus, but versioned Java tools may need this.
176 # Check whether the user set the override and return it if yes.
177 BuiltIn.Run_Keyword_And_Return_If """${openjdk}""" == "openjdk8" Compose_Dilemma_Filepath ${JAVA_8_HOME_CENTOS}/bin/java ${JAVA_8_HOME_UBUNTU}/bin/java
178 BuiltIn.Run_Keyword_And_Return_If """${openjdk}""" == "openjdk7" Compose_Dilemma_Filepath ${JAVA_7_HOME_CENTOS}/bin/java ${JAVA_7_HOME_UBUNTU}/bin/java
179 BuiltIn.Run_Keyword_And_Return_If """${openjdk}""" == "openjdk11" Compose_Dilemma_Filepath ${JAVA_11_HOME_CENTOS}/bin/java ${JAVA_11_HOME_UBUNTU}/bin/java
180 # Attempt to call plain "java" command directly. If it works, return it.
181 ${out} ${rc} = SSHLibrary.Execute_Command java -version 2>&1 return_rc=True
182 BuiltIn.Return_From_Keyword_If ${rc} == 0 java
183 # Query the virtual machine for the JAVA_HOME environment variable and
184 # use it to assemble a (hopefully) working command. If that worked out,
186 ${java} = SSHLibrary.Execute_Command echo $JAVA_HOME/bin/java 2>&1
187 ${out} ${rc} = SSHLibrary.Execute_Command ${java} -version 2>&1 return_rc=True
188 BuiltIn.Return_From_Keyword_If ${rc} == 0 ${java}
189 # There are bizzare test environment setups where the (correct) JAVA_HOME
190 # is set in the VM where Robot is running but not in the VM where the
191 # tools are supposed to run (usually because these two are really one
192 # and the same system and idiosyncracies of BASH prevent easy injection
193 # of the JAVA_HOME environment variable into a place where connections
194 # made by SSHLibrary would pick it up). So try to use that value to
195 # create a java command and check that it works.
196 ${JAVA_HOME} = OperatingSystem.Get_Environment_Variable JAVA_HOME ${EMPTY}
197 ${java} = BuiltIn.Set_Variable_If """${JAVA_HOME}"""!="" ${JAVA_HOME}/bin/java false
198 ${out} ${rc} = SSHLibrary.Execute_Command ${java} -version 2>&1 return_rc=True
199 BuiltIn.Return_From_Keyword_If ${rc} == 0 ${java}
200 # Nothing works, most likely java is not installed at all on the target
201 # machine or it is hopelesly lost. Bail out with a helpful message
202 # telling the user how to make it accessible for the script.
203 BuiltIn.Fail Unable to find Java; specify \${JDKVERSION}, put it to your PATH or set JAVA_HOME environment variable.
205 Compose_Full_Java_Command
206 [Arguments] ${options} ${openjdk}=${JDKVERSION}
207 [Documentation] Return full Bash command to run Java with given options.
208 ... This requires that the SSH connection on which the command is going to be used is active as it is needed for querying files.
209 ... The options may include JVM options, application command line arguments, Bash redirects and other constructs.
210 ${base_command} = Compose_Base_Java_Command openjdk=${openjdk}
211 ${full_command} = BuiltIn.Set_Variable ${base_command} ${options}
212 BuiltIn.Log ${full_command}
213 [Return] ${full_command}
216 [Arguments] ${openjdk}=${JDKVERSION}
217 [Documentation] Compose base java command and strip trailing "/bin/java".
218 ${java_command} = Compose_Base_Java_Command
219 ${java_home} ${bin} ${java} = String.Split_String_From_Right ${java_command} separator=/ max_split=2
220 [Return] ${java_home}
223 [Arguments] ${openjdk}=${JDKVERSION}
224 [Documentation] Return Java options suitable for current JDK version.
225 ${java_actual_options} = BuiltIn.Set_Variable_If """${openjdk}""" == "openjdk7" ${JAVA_7_OPTIONS} ${JAVA_OPTIONS}
226 [Return] ${java_actual_options}
229 [Arguments] ${maven_version}=3.3.9 ${openjdk}=${JDKVERSION}
230 [Documentation] Download and unpack Maven, prepare launch command with proper Java version and download settings file.
231 ... This Keyword requires an active SSH connection to target machine.
232 ... This Keyword sets global variables, so that suites can reuse existing installation.
233 ... This Keyword can only place Maven (and settings) to remote current working directory.
234 ... This Keyword does not perform any initial or final cleanup.
235 # Avoid multiple initialization by several downstream libraries.
236 ${installed_version} = BuiltIn.Get_Variable_Value \${Maven__installed_version} None
237 BuiltIn.Return_From_Keyword_If """${installed_version}""" == """${maven_version}"""
238 BuiltIn.Set_Global_Variable \${Maven__installed_version} ${maven_version}
239 BuiltIn.Set_Global_Variable \${maven_directory} apache-maven-${maven_version}
240 SSHKeywords.Execute_Command_At_Cwd_Should_Pass rm -rf '${maven_directory}'
241 ${maven_archive_filename} = BuiltIn.Set_Variable ${maven_directory}-bin.tar.gz
242 ${maven_download_url} = BuiltIn.Set_Variable http://www-us.apache.org/dist/maven/maven-3/${maven_version}/binaries/${maven_archive_filename}
243 SSHKeywords.Execute_Command_At_Cwd_Should_Pass wget -N '${maven_download_url}' stderr_must_be_empty=False
244 SSHKeywords.Execute_Command_At_Cwd_Should_Pass tar xvf '${maven_archive_filename}'
245 ${java_home} = NexusKeywords.Compose_Java_Home openjdk=${openjdk}
246 ${java_actual_options} = Default_Java_Options ${openjdk}
247 BuiltIn.Set_Global_Variable \${maven_bash_command} export JAVA_HOME='${java_home}' && export MAVEN_OPTS='${java_actual_options}' && ./${maven_directory}/bin/mvn
248 # TODO: Get settings files from Jenkins settings provider, somehow.
249 SSHKeywords.Execute_Command_At_Cwd_Should_Pass wget '${MAVEN_SETTINGS_URL}' -O settings.xml stderr_must_be_empty=False
252 [Arguments] ${maven_version}=3.3.9 ${openjdk}=${JDKVERSION} ${branch}=${EMPTY} ${patches}=${EMPTY}
253 [Documentation] Install Maven.
254 ... Depending on arguments, perform a multipatch build to populate local Maven repository with patched artifacts.
255 Install_Maven_Bare maven_version=${maven_version} openjdk=${openjdk}
256 BuiltIn.Return_From_Keyword_If """${patches}""" == "" No post-install build requested.
257 BuiltIn.Run_Keyword_If """${branch}""" == "" BuiltIn.Fail BRANCH needs to be specified for multipatch builds.
258 ${script_name} = BuiltIn.Set_Variable include-raw-integration-multipatch-distribution-test.sh
259 ${script_url} = BuiltIn.Set_Variable https://raw.githubusercontent.com/opendaylight/releng-builder/master/jjb/integration/${script_name}
260 SSHKeywords.Execute_Command_At_Cwd_Should_Pass wget -N '${script_url}' stderr_must_be_empty=False
261 SSHKeywords.Execute_Command_At_Cwd_Should_Pass export WORKSPACE='${WORKSPACE}' && export BRANCH='${branch}' && export PATCHES_TO_BUILD='${patches}' && bash '${script_name}' stderr_must_be_empty=False
262 Run_Maven pom_file=${WORKSPACE}/patch_tester/pom.xml
265 [Arguments] ${pom_file}=pom.xml ${log_file}=${MAVEN_DEFAULT_OUTPUT_FILENAME}
266 [Documentation] Determine arguments to use and call mvn command against given pom file.
267 SSHKeywords.Execute_Command_At_Cwd_Should_Pass mkdir -p '${MAVEN_REPOSITORY_PATH}'
268 ${maven_repository_options} = BuiltIn.Set_Variable -Dmaven.repo.local=${MAVEN_REPOSITORY_PATH} -Dorg.ops4j.pax.url.mvn.localRepository=${MAVEN_REPOSITORY_PATH}
269 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}'
271 Get_ODL_Versions_From_Nexus
272 [Documentation] Returns name of last release found on nexus and list of all versions.
273 RequestsLibrary.Create_Session nexus ${NEXUS_RELEASES_URL} verify=${TRUE}
274 ${uri}= BuiltIn.Set_Variable maven-metadata.xml
275 ${response}= RequestsLibrary.Get_Request nexus ${uri}
276 BuiltIn.Log ${response.text}
277 ${root}= XML.Parse_XML ${response.text}
278 ${element}= XML.Get_Element ${root} versioning/latest
279 ${latest}= BuiltIn.Set_Variable ${element.text}
280 BuiltIn.Log ${latest}
281 @{elements}= XML.Get_Elements ${root} .//version
282 ${versions}= BuiltIn.Create_List
283 FOR ${element} IN @{elements}
284 Collections.Append_To_List ${versions} ${element.text}
286 Collections.Sort_List ${versions}
287 BuiltIn.Log_Many @{versions}
288 [Return] ${latest} @{versions}
290 Get_Latest_ODL_Release_From_Nexus
291 [Documentation] Returns name of last release found on nexus
292 ${latest} @{versions}= Get_ODL_Versions_From_Nexus
295 Get_Latest_ODL_Stream_Release
296 [Arguments] ${stream}=latest
297 [Documentation] Returns name for last release for specified stream.
298 ${latest} @{versions}= Get_ODL_Versions_From_Nexus
299 BuiltIn.Return_From_Keyword_If '${stream}'=='latest' ${latest}
300 ${latest_version}= BuiltIn.Set_Variable xxx
301 FOR ${version} IN @{versions}
302 ${latest_version}= BuiltIn.Set_Variable_If '${stream}'.title() in '${version}' ${version} ${latest_version}
304 BuiltIn.Run_Keyword_If '${latest_version}'=='xxx' BuiltIn.Fail Could not find latest release for stream ${stream}
305 BuiltIn.Log ${latest_version}
306 [Return] ${latest_version}
308 Get_Latest_ODL_Stream_Release_URL
309 [Arguments] ${stream}=latest ${format}=.zip
310 [Documentation] Returns URL for last release for specified stream. Default format is .zip.
311 ${latest_version}= Get_Latest_ODL_Stream_Release ${stream}
312 ${url}= BuiltIn.Set_Variable ${NEXUS_RELEASES_URL}/${latest_version}/distribution-karaf-${latest_version}${format}
316 Get_Latest_ODL_Previous_Stream_Release
317 [Arguments] ${stream}=${ODL_STREAM}
318 [Documentation] Returns name for last release for previous stream of specified stream.
319 ... Note: If specified stream is not found on nexus, then it is taken as new one (not released yet).
320 ... So in this case, latest release version is return.
321 ${latest} @{versions}= Get_ODL_Versions_From_Nexus
322 ${latest_version}= BuiltIn.Set_Variable xxx
323 FOR ${version} IN @{versions}
324 BuiltIn.Exit_For_Loop_If '${stream}'.title() in '${version}'
325 ${latest_version}= BuiltIn.Set_Variable ${version}
327 BuiltIn.Run_Keyword_If '${latest_version}'=='xxx' BuiltIn.Fail Could not find latest previous release for stream ${stream}
328 BuiltIn.Log ${latest_version}
329 [Return] ${latest_version}
331 Get_Latest_ODL_Previous_Stream_Release_URL
332 [Arguments] ${stream}=${ODL_STREAM} ${format}=.zip
333 [Documentation] Returns URL for last release for previous stream of specified stream. Default format is .zip.
334 ${latest_version}= Get_Latest_ODL_Previous_Stream_Release ${stream}
335 ${url}= BuiltIn.Set_Variable ${NEXUS_RELEASES_URL}/${latest_version}/distribution-karaf-${latest_version}${format}