Append 3 more punt path protection TCs
[integration/test.git] / csit / libraries / NexusKeywords.robot
index 27f15ea2b51909e1857e99e90eb5a1111e1b1539..09f2a4fb6279a9096c3e911ff7b8cb2a9241b7e0 100644 (file)
@@ -14,12 +14,18 @@ Documentation     Nexus repository access keywords, and supporting Java and Mave
 ...               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}/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
 ${JDKVERSION}     None
 ${JAVA_7_HOME_CENTOS}    /usr/lib/jvm/java-1.7.0
 ${JAVA_7_HOME_UBUNTU}    /usr/lib/jvm/java-7-openjdk-amd64
@@ -28,11 +34,13 @@ ${JAVA_8_HOME_UBUNTU}    /usr/lib/jvm/java-8-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/distribution-karaf
 
 *** Keywords ***
 Initialize_Artifact_Deployment_And_Usage
@@ -52,8 +60,11 @@ 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}
@@ -71,19 +82,32 @@ NexusKeywords__Detect_Version_To_Pull
     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}
     [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}
@@ -91,20 +115,21 @@ Deploy_Artifact
     ${version}    ${location} =    NexusKeywords__Detect_Version_To_Pull    ${component}
     # 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}
     [Return]    ${filename}
 
 Deploy_Test_Tool
-    [Arguments]    ${component}    ${artifact}    ${suffix}=executable
+    [Arguments]    ${component}    ${artifact}    ${suffix}=executable    ${fallback_url}=${NEXUS_FALLBACK_URL}    ${explicit_url}=${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"
@@ -114,10 +139,25 @@ 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    -${suffix}.jar
-    ${filename} =    Deploy_Artifact    ${component}    ${artifact}    ${name_prefix}    ${name_suffix}
+    ${name_suffix} =    BuiltIn.Set_Variable_If    "${suffix}" != ""    -${suffix}.jar    .jar
+    ${filename} =    Deploy_Artifact    ${component}    ${artifact}    ${name_prefix}    ${name_suffix}    ${fallback_url}
+    ...    ${explicit_url}
     [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.
+    ${default_java_options} =    Default_Java_Options    ${openjdk}
+    ${actual_java_options} =    BuiltIn.Set_Variable_If    """${java_options}""" != ""    ${java_options}    ${default_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.
@@ -176,6 +216,12 @@ 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.
@@ -194,7 +240,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} =    BuiltIn.Set_Variable_If    """${openjdk}""" == "openjdk7"    ${JAVA_7_OPTIONS}    ${JAVA_OPTIONS}
+    ${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
     # 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
@@ -218,3 +264,68 @@ 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}
+    \    Collections.Append_To_List    ${versions}    ${element.text}
+    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}
+    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}/distribution-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.
+    ${latest}    @{versions}=    Get_ODL_Versions_From_Nexus
+    ${latest_version}=    BuiltIn.Set_Variable    xxx
+    : FOR    ${version}    IN    @{versions}
+    \    BuiltIn.Exit_For_Loop_If    '${stream}'.title() in '${version}'
+    \    ${latest_version}=    BuiltIn.Set_Variable    ${version}
+    BuiltIn.Run_Keyword_If    '${latest_version}'=='xxx'    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}/distribution-karaf-${latest_version}${format}
+    BuiltIn.Log    ${url}
+    [Return]    ${url}