Append 3 more punt path protection TCs
[integration/test.git] / csit / libraries / NexusKeywords.robot
index 7458312b047c4363a99bf79d97afae7554df4e17..09f2a4fb6279a9096c3e911ff7b8cb2a9241b7e0 100644 (file)
@@ -14,13 +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
+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
@@ -34,6 +39,8 @@ ${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
@@ -53,9 +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
-    BuiltIn.Return_From_Keyword_If    '${component}' == 'yangtools'    yang-data-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}
@@ -75,7 +84,7 @@ NexusKeywords__Detect_Version_To_Pull
     SSHLibrary.Close_Connection
     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}
 
@@ -89,13 +98,15 @@ Deploy_From_Url
     [Return]    ${filename}
 
 Deploy_Artifact
-    [Arguments]    ${component}    ${artifact}    ${name_prefix}    ${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}
     [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),
@@ -104,10 +115,11 @@ 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}
+    # TODO: Review SSHKeywords for current best keywords to call.
     ${metadata} =    SSHKeywords.Execute_Command_Should_Pass    curl -L ${url}/maven-metadata.xml
-    ${namepart} =    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}
+    ${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}
@@ -252,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}