Use RFC8040 URL for OVSDB tests
[integration/test.git] / csit / libraries / NexusKeywords.robot
index 2441000568d95d4a3f6f60a6ffe3d65e54dc5e8c..120bb6b7c3f7a9103d414ca89491038ba2a5ec68 100644 (file)
@@ -18,24 +18,30 @@ Library           Collections
 Library           OperatingSystem
 Library           SSHLibrary
 Library           String
+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    yangtools=yang-data-impl    carpeople=clustering-it-model
+&{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_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
@@ -93,7 +99,7 @@ Deploy_From_Url
     [Return]    ${filename}
 
 Deploy_Artifact
-    [Arguments]    ${component}    ${artifact}    ${name_prefix}=${artifact}-    ${name_suffix}=-executable.jar    ${fallback_url}=${NEXUS_FALLBACK_URL}    ${explicit_url}=${EMPTY}
+    [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
@@ -106,8 +112,21 @@ Deploy_Artifact
     ${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}
     # TODO: Review SSHKeywords for current best keywords to call.
@@ -120,11 +139,15 @@ Deploy_Artifact
     ${url} =    BuiltIn.Set_Variable    ${url}/${filename}
     ${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    ${fallback_url}=${NEXUS_FALLBACK_URL}    ${explicit_url}=${EMPTY}
+    [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"
@@ -134,9 +157,10 @@ Deploy_Test_Tool
     ...    "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_If    "${suffix}" != ""    -${suffix}.jar    .jar
+    ${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}
+    ...    ${explicit_url}    ${build_version}    ${build_location}
     [Return]    ${filename}
 
 Install_And_Start_Java_Artifact
@@ -145,8 +169,7 @@ Install_And_Start_Java_Artifact
     [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.
-    ${default_java_options} =    Default_Java_Options    ${openjdk}
-    ${actual_java_options} =    BuiltIn.Set_Variable_If    """${java_options}""" != ""    ${java_options}    ${default_java_options}
+    ${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}
@@ -168,14 +191,14 @@ Compose_Base_Java_Command
     ...    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
@@ -211,12 +234,6 @@ Compose_Java_Home
     ${java_home}    ${bin}    ${java} =    String.Split_String_From_Right    ${java_command}    separator=/    max_split=2
     [Return]    ${java_home}
 
-Default_Java_Options
-    [Arguments]    ${openjdk}=${JDKVERSION}
-    [Documentation]    Return Java options suitable for current JDK version.
-    ${java_actual_options} =    BuiltIn.Set_Variable_If    """${openjdk}""" == "openjdk7"    ${JAVA_7_OPTIONS}    ${JAVA_OPTIONS}
-    [Return]    ${java_actual_options}
-
 Install_Maven_Bare
     [Arguments]    ${maven_version}=3.3.9    ${openjdk}=${JDKVERSION}
     [Documentation]    Download and unpack Maven, prepare launch command with proper Java version and download settings file.
@@ -235,8 +252,7 @@ Install_Maven_Bare
     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} =    Default_Java_Options    ${openjdk}
-    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
 
@@ -259,3 +275,83 @@ Run_Maven
     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}