diff options
27 files changed, 471 insertions, 464 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index c4cbae775..000000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,40 +0,0 @@ -# SPDX-license-identifier: Apache-2.0 -############################################################################## -# Copyright (c) 2016 Linux Foundation and others. -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## -''' -Base configuration file for building OPNFV docs - -You can override this configuration by putting 'conf.py' in the document -directory (e.g. docs/how-to-use-docs/conf.py). If there is no 'conf.py' -in the document directory, this file will be copied to that directory -before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge'). - -You may need python package installation for new sphinx extension. -Install python package with 'pip' in your machine and add the extension to -the 'extensions' list below to test the documentation build locally. -If you feel that your extensions would be useful for other projects too, -we encourage you to propose a change in the releng repository. - -For further guidance see the https://wiki.opnfv.org/documentation/tools page. -''' - -extensions = ['sphinxcontrib.httpdomain', - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon'] - -needs_sphinx = '1.3' -master_doc = 'index' -pygments_style = 'sphinx' - -html_use_index = False -numfig = True -html_logo = 'opnfv-logo.png' - -latex_domain_indices = False -latex_logo = 'opnfv-logo.png' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503eb..000000000 --- a/docs/etc/opnfv-logo.png +++ /dev/null diff --git a/docs/etc/requirements.txt b/docs/etc/requirements.txt deleted file mode 100644 index 4b1850729..000000000 --- a/docs/etc/requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -Sphinx==1.3.1 -doc8 -docutils -setuptools -six -sphinxcontrib-httpdomain diff --git a/jjb/compass4nfv/compass-upload-artifact.sh b/jjb/compass4nfv/compass-upload-artifact.sh index 34b1db98c..73b7f07fa 100644 --- a/jjb/compass4nfv/compass-upload-artifact.sh +++ b/jjb/compass4nfv/compass-upload-artifact.sh @@ -10,6 +10,27 @@ echo # source the opnfv.properties to get ARTIFACT_VERSION source $BUILD_DIRECTORY/opnfv.properties +# clone releng repository +echo "Cloning releng repository..." +[ -d releng ] && rm -rf releng +git clone https://gerrit.opnfv.org/gerrit/releng $WORKSPACE/releng/ &> /dev/null +#this is where we import the siging key +if [ -f $WORKSPACE/releng/utils/gpg_import_key.sh ]; then + source $WORKSPACE/releng/utils/gpg_import_key.sh +fi + +signiso () { +time gpg2 -vvv --batch --yes --no-tty \ + --default-key opnfv-helpdesk@rt.linuxfoundation.org \ + --passphrase besteffort \ + --detach-sig $BUILD_DIRECTORY/compass.iso + +gsutil cp $BUILD_DIRECTORY/compass.iso.sig gs://$GS_URL/opnfv-$OPNFV_ARTIFACT_VERSION.iso.sig +echo "ISO signature Upload Complete!" +} + +signiso + # upload artifact and additional files to google storage gsutil cp $BUILD_DIRECTORY/compass.iso gs://$GS_URL/opnfv-$OPNFV_ARTIFACT_VERSION.iso > gsutil.iso.log 2>&1 gsutil cp $BUILD_DIRECTORY/opnfv.properties gs://$GS_URL/opnfv-$OPNFV_ARTIFACT_VERSION.properties > gsutil.properties.log 2>&1 diff --git a/jjb/fastpathmetrics/fastpathmetrics.yml b/jjb/fastpathmetrics/fastpathmetrics.yml index ad1b601da..40549e3c5 100644 --- a/jjb/fastpathmetrics/fastpathmetrics.yml +++ b/jjb/fastpathmetrics/fastpathmetrics.yml @@ -151,8 +151,7 @@ choosing-strategy: 'default' triggers: - - pollscm: - cron: '@midnight' + - timed: '@midnight' builders: - shell: | diff --git a/jjb/multisite/multisite.yml b/jjb/multisite/multisite.yml new file mode 100644 index 000000000..f92a4c1bf --- /dev/null +++ b/jjb/multisite/multisite.yml @@ -0,0 +1,122 @@ +################################################### +# All the jobs except verify have been removed! +# They will only be enabled on request by projects! +################################################### +- project: + name: multisite + + project: '{name}' + + jobs: + - 'multisite-verify-{stream}' + - 'multisite-kingbird-daily-{stream}' + + stream: + - master: + branch: '{stream}' + gs-pathname: '' + disabled: false + +- job-template: + name: 'multisite-verify-{stream}' + + disabled: '{obj:disabled}' + + parameters: + - project-parameter: + project: '{project}' + - gerrit-parameter: + branch: '{branch}' + - 'opnfv-build-ubuntu-defaults' + + scm: + - gerrit-trigger-scm: + credentials-id: '{ssh-credentials}' + refspec: '$GERRIT_REFSPEC' + choosing-strategy: 'gerrit' + + triggers: + - gerrit: + trigger-on: + - patchset-created-event: + exclude-drafts: 'false' + exclude-trivial-rebase: 'false' + exclude-no-code-change: 'false' + - draft-published-event + - comment-added-contains-event: + comment-contains-value: 'recheck' + - comment-added-contains-event: + comment-contains-value: 'reverify' + projects: + - project-compare-type: 'ANT' + project-pattern: '{project}' + branches: + - branch-compare-type: 'ANT' + branch-pattern: '**/{branch}' + forbidden-file-paths: + - compare-type: ANT + pattern: 'docs/**|.gitignore' + + builders: + - shell: | + #!/bin/bash + + echo "Hello World" + +- job-template: + name: 'multisite-kingbird-daily-{stream}' + + project-type: freestyle + + disabled: '{obj:disabled}' + + concurrent: true + + properties: + - throttle: + enabled: true + max-total: 3 + max-per-node: 2 + option: 'project' + + parameters: + - project-parameter: + project: '{project}' + - gerrit-parameter: + branch: '{branch}' + - string: + name: KINGBIRD_LOG_FILE + default: $WORKSPACE/kingbird.log + - 'intel-virtual6-defaults' + + scm: + - gerrit-trigger-scm: + credentials-id: '{ssh-credentials}' + refspec: '' + choosing-strategy: 'default' + + triggers: + - timed: '@midnight' + + builders: + - 'multisite-kingbird-deploy' + - 'multisite-kingbird-log-upload' +######################## +# builder macros +######################## +- builder: + name: 'multisite-kingbird-deploy' + builders: + - shell: | + #!/bin/bash + + $WORKSPACE/tools/kingbird/deploy.sh +- builder: + name: 'multisite-kingbird-log-upload' + builders: + - shell: | + #!/bin/bash + + echo "Here is where we upload kingbird logs to artifact repo" + echo "We just check the existence of log file" + ls -al $KINGBIRD_LOG_FILE diff --git a/jjb/opnfv/slave-params.yml b/jjb/opnfv/slave-params.yml index b7ecfde29..7b9983060 100644 --- a/jjb/opnfv/slave-params.yml +++ b/jjb/opnfv/slave-params.yml @@ -474,6 +474,20 @@ name: LAB_CONFIG_URL default: ssh://git@git.enea.com/pharos/lab-config description: 'Base URI to the configuration directory' +- parameter: + name: 'intel-virtual6-defaults' + parameters: + - node: + name: SLAVE_NAME + description: 'Slave name on Jenkins' + allowed-slaves: + - intel-virtual6 + default-slaves: + - intel-virtual6 + - string: + name: GIT_BASE + default: https://gerrit.opnfv.org/gerrit/$PROJECT + description: 'Git URL to use on this Jenkins Slave' ##################################################### # These slaves are just dummy slaves for sandbox jobs ##################################################### @@ -497,7 +511,7 @@ parameters: - label: name: SLAVE_LABEL - default: 'sandbox-virtual-defaults' + default: 'sandbox-virtual' description: 'Slave label on Jenkins' - string: name: GIT_BASE @@ -512,7 +526,7 @@ parameters: - label: name: SLAVE_LABEL - default: 'dummy-pod1-defaults' + default: 'dummy-pod1' description: 'Slave label on Jenkins' - string: name: GIT_BASE diff --git a/jjb/qtip/qtip-ci-jobs.yml b/jjb/qtip/qtip-ci-jobs.yml index 6e9a20de5..36f026d7c 100644 --- a/jjb/qtip/qtip-ci-jobs.yml +++ b/jjb/qtip/qtip-ci-jobs.yml @@ -81,7 +81,7 @@ publishers: - email: - recipients: nauman.ahad@xflowresearch.com, mofassir.arif@xflowresearch.com, vikram@nvirters.com + recipients: nauman.ahad@xflowresearch.com, mofassir.arif@xflowresearch.com, vikram@nvirters.com, zhang.yujunz@zte.com.cn ########################### #biuilder macros diff --git a/jjb/releng-macros.yaml b/jjb/releng-macros.yaml index 631a33f41..7733abac4 100644 --- a/jjb/releng-macros.yaml +++ b/jjb/releng-macros.yaml @@ -178,8 +178,8 @@ set -o errexit set -o xtrace export PATH=$PATH:/usr/local/bin/ - git clone ssh://gerrit.opnfv.org:29418/releng - GERRIT_COMMENT=gerrit_comment.txt ./releng/utils/docs-build.sh + git clone ssh://gerrit.opnfv.org:29418/opnfvdocs docs_build/_opnfvdocs + GERRIT_COMMENT=gerrit_comment.txt ./docs_build/_opnfvdocs/scripts/docs-build.sh - builder: name: upload-under-review-docs-to-opnfv-artifacts diff --git a/jjb/sandbox/basic.sh b/jjb/sandbox/basic.sh index 2f9be2729..33268558c 100755 --- a/jjb/sandbox/basic.sh +++ b/jjb/sandbox/basic.sh @@ -59,3 +59,5 @@ echo "git show" echo "-------------------------------------" git show echo "-------------------------------------" + +sleep 60 diff --git a/jjb/sandbox/build.sh b/jjb/sandbox/build.sh index 2f9be2729..33268558c 100755 --- a/jjb/sandbox/build.sh +++ b/jjb/sandbox/build.sh @@ -59,3 +59,5 @@ echo "git show" echo "-------------------------------------" git show echo "-------------------------------------" + +sleep 60 diff --git a/jjb/sandbox/deploy.sh b/jjb/sandbox/deploy.sh index 2f9be2729..33268558c 100755 --- a/jjb/sandbox/deploy.sh +++ b/jjb/sandbox/deploy.sh @@ -59,3 +59,5 @@ echo "git show" echo "-------------------------------------" git show echo "-------------------------------------" + +sleep 60 diff --git a/jjb/sandbox/sandbox-verify-jobs.yml b/jjb/sandbox/sandbox-verify-jobs.yml index a899193d7..e0bc2183f 100644 --- a/jjb/sandbox/sandbox-verify-jobs.yml +++ b/jjb/sandbox/sandbox-verify-jobs.yml @@ -4,32 +4,66 @@ project: 'sandbox' installer: 'sandbox' - +##################################### +# branch definitions +##################################### stream: - master: branch: '{stream}' gs-pathname: '' - -# what are the verification activities we do for this installer - activity: - - 'basic' - - 'build' - - 'deploy' - - 'test' - + disabled: false + - colorado: + branch: 'stable/{stream}' + gs-pathname: '/{stream}' + disabled: true +##################################### +# patch verification phases +##################################### + phase: + - 'basic': + slave-label: 'opnfv-build-ubuntu' + - 'build': + slave-label: 'opnfv-build-ubuntu' + - 'deploy-virtual': + slave-label: 'sandbox-virtual' + - 'smoke-test': + slave-label: 'sandbox-virtual' +##################################### +# jobs +##################################### jobs: - 'sandbox-verify-{stream}' - - 'sandbox-verify-{activity}-{stream}' - + - 'sandbox-verify-{phase}-{stream}' +##################################### +# job templates +##################################### - job-template: name: 'sandbox-verify-{stream}' - parameters: - - project-parameter: - project: '{project}' - - gerrit-parameter: - branch: '{branch}' - - 'opnfv-build-ubuntu-defaults' + project-type: multijob + + disabled: '{obj:disabled}' + + concurrent: true + + properties: + - throttle: + enabled: true + max-total: 2 + max-per-node: 1 + option: 'project' + - build-blocker: + use-build-blocker: true + blocking-jobs: + - 'sandbox-verify-master' + - 'sandbox-verify-colorado' + block-level: 'NODE' + + scm: + - gerrit-trigger-scm: + credentials-id: '{ssh-credentials}' + refspec: '$GERRIT_REFSPEC' + choosing-strategy: 'gerrit' wrappers: - ssh-agent-credentials: @@ -62,45 +96,90 @@ pattern: 'docs/**|.gitignore' readable-message: true + parameters: + - project-parameter: + project: '{project}' + - gerrit-parameter: + branch: '{branch}' + - 'sandbox-virtual-defaults' + builders: - description-setter: description: "Built on $NODE_NAME" - - '{project}-verify-builder' - - trigger-builds: - - project: 'sandbox-verify-basic-{stream}' - current-parameters: false - predefined-parameters: | - GERRIT_BRANCH=$GERRIT_BRANCH - GERRIT_REFSPEC=$GERRIT_REFSPEC - GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER - block: true - - trigger-builds: - - project: 'sandbox-verify-build-{stream}' - current-parameters: false - predefined-parameters: | - GERRIT_BRANCH=$GERRIT_BRANCH - GERRIT_REFSPEC=$GERRIT_REFSPEC - GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER - block: true - - trigger-builds: - - project: 'sandbox-verify-deploy-{stream}' - current-parameters: false - predefined-parameters: | - GERRIT_BRANCH=$GERRIT_BRANCH - GERRIT_REFSPEC=$GERRIT_REFSPEC - GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER - block: true - - trigger-builds: - - project: 'sandbox-verify-test-{stream}' - current-parameters: false - predefined-parameters: | - GERRIT_BRANCH=$GERRIT_BRANCH - GERRIT_REFSPEC=$GERRIT_REFSPEC - GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER - block: true + - multijob: + name: basic + condition: SUCCESSFUL + projects: + - name: 'sandbox-verify-basic-{stream}' + current-parameters: false + predefined-parameters: | + GERRIT_BRANCH=$GERRIT_BRANCH + GERRIT_REFSPEC=$GERRIT_REFSPEC + GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER + GERRIT_CHANGE_COMMIT_MESSAGE=$GERRIT_CHANGE_COMMIT_MESSAGE + kill-phase-on: FAILURE + abort-all-job: true + - multijob: + name: build + condition: SUCCESSFUL + projects: + - name: 'sandbox-verify-build-{stream}' + current-parameters: false + predefined-parameters: | + GERRIT_BRANCH=$GERRIT_BRANCH + GERRIT_REFSPEC=$GERRIT_REFSPEC + GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER + GERRIT_CHANGE_COMMIT_MESSAGE=$GERRIT_CHANGE_COMMIT_MESSAGE + kill-phase-on: FAILURE + abort-all-job: true + - multijob: + name: deploy-virtual + condition: SUCCESSFUL + projects: + - name: 'sandbox-verify-deploy-virtual-{stream}' + current-parameters: false + predefined-parameters: | + GERRIT_BRANCH=$GERRIT_BRANCH + GERRIT_REFSPEC=$GERRIT_REFSPEC + GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER + GERRIT_CHANGE_COMMIT_MESSAGE=$GERRIT_CHANGE_COMMIT_MESSAGE + node-parameters: true + kill-phase-on: FAILURE + abort-all-job: true + - multijob: + name: smoke-test + condition: SUCCESSFUL + projects: + - name: 'sandbox-verify-smoke-test-{stream}' + current-parameters: false + predefined-parameters: | + GERRIT_BRANCH=$GERRIT_BRANCH + GERRIT_REFSPEC=$GERRIT_REFSPEC + GERRIT_CHANGE_NUMBER=$GERRIT_CHANGE_NUMBER + GERRIT_CHANGE_COMMIT_MESSAGE=$GERRIT_CHANGE_COMMIT_MESSAGE + node-parameters: true + kill-phase-on: FAILURE + abort-all-job: true - job-template: - name: 'sandbox-verify-{activity}-{stream}' + name: 'sandbox-verify-{phase}-{stream}' + + disabled: '{obj:disabled}' + + concurrent: true + + properties: + - throttle: + enabled: true + max-total: 2 + max-per-node: 1 + option: 'project' + - build-blocker: + use-build-blocker: true + blocking-jobs: + - 'sandbox-verify-deploy-.*' + - 'sandbox-verify-test-.*' + block-level: 'NODE' scm: - gerrit-trigger-scm: @@ -115,71 +194,41 @@ - timeout: timeout: 360 fail: true - parameters: - project-parameter: project: '{project}' - gerrit-parameter: branch: '{branch}' - '{installer}-defaults' - - '{project}-verify-{activity}-parameter' + - '{slave-label}-defaults' builders: - description-setter: description: "Built on $NODE_NAME" - - '{project}-verify-{activity}-builder' - + - '{project}-verify-{phase}-macro' ##################################### -# parameter builders +# builder macros ##################################### -- parameter: - name: 'sandbox-verify-basic-parameter' - parameters: - - 'opnfv-build-ubuntu-defaults' - -- parameter: - name: 'sandbox-verify-build-parameter' - parameters: - - 'opnfv-build-ubuntu-defaults' - -- parameter: - name: 'sandbox-verify-deploy-parameter' - parameters: - - 'opnfv-build-centos-defaults' - -- parameter: - name: 'sandbox-verify-test-parameter' - parameters: - - 'opnfv-build-centos-defaults' -##################################### -# builder builders -##################################### -- builder: - name: 'sandbox-verify-builder' - builders: - - shell: - !include-raw: ./verify.sh - - builder: - name: 'sandbox-verify-basic-builder' + name: 'sandbox-verify-basic-macro' builders: - shell: !include-raw: ./basic.sh - builder: - name: 'sandbox-verify-build-builder' + name: 'sandbox-verify-build-macro' builders: - shell: !include-raw: ./build.sh - builder: - name: 'sandbox-verify-deploy-builder' + name: 'sandbox-verify-deploy-virtual-macro' builders: - shell: !include-raw: ./deploy.sh - builder: - name: 'sandbox-verify-test-builder' + name: 'sandbox-verify-smoke-test-macro' builders: - shell: !include-raw: ./test.sh diff --git a/jjb/sandbox/test.sh b/jjb/sandbox/test.sh index 2f9be2729..33268558c 100755 --- a/jjb/sandbox/test.sh +++ b/jjb/sandbox/test.sh @@ -59,3 +59,5 @@ echo "git show" echo "-------------------------------------" git show echo "-------------------------------------" + +sleep 60 diff --git a/jjb/sandbox/verify.sh b/jjb/sandbox/verify.sh deleted file mode 100755 index f62d2b977..000000000 --- a/jjb/sandbox/verify.sh +++ /dev/null @@ -1,29 +0,0 @@ -#!/bin/bash - -# this is where we check the commit message, unit test, etc. -cd $WORKSPACE -echo -echo "Commit Message is" -echo "-------------------------------------" -git log --format=%B -n 1 $(git rev-parse HEAD) -echo "-------------------------------------" -echo -echo "Repo contents" -echo "-------------------------------------" -ls -al -echo "-------------------------------------" -echo -echo "Changed files are" -echo "-------------------------------------" -git diff origin/master --name-only -echo "-------------------------------------" -echo -echo "Change introduced" -echo "-------------------------------------" -git diff origin/master -echo "-------------------------------------" -echo -echo "git show" -echo "-------------------------------------" -git show -echo "-------------------------------------" diff --git a/jjb/yardstick/yardstick-project-jobs.yml b/jjb/yardstick/yardstick-project-jobs.yml index 5973fcec4..7656c920e 100644 --- a/jjb/yardstick/yardstick-project-jobs.yml +++ b/jjb/yardstick/yardstick-project-jobs.yml @@ -133,7 +133,7 @@ sphinx-apidoc -o docs/apidocs yardstick # build docs - git clone ssh://gerrit.opnfv.org:29418/releng - GERRIT_COMMENT=gerrit_comment.txt ./releng/utils/docs-build.sh + git clone ssh://gerrit.opnfv.org:29418/opnfvdocs docs_build/_opnfvdocs + GERRIT_COMMENT=gerrit_comment.txt ./docs_build/_opnfvdocs/scripts/docs-build.sh deactivate diff --git a/utils/docs-build.sh b/utils/docs-build.sh deleted file mode 100755 index 48037db2e..000000000 --- a/utils/docs-build.sh +++ /dev/null @@ -1,234 +0,0 @@ -#!/bin/bash -e -# SPDX-license-identifier: Apache-2.0 -############################################################################## -# Copyright (c) 2016 NEC and others. -# All rights reserved. This program and the accompanying materials -# are made available under the terms of the Apache License, Version 2.0 -# which accompanies this distribution, and is available at -# http://www.apache.org/licenses/LICENSE-2.0 -############################################################################## -export PATH=$PATH:/usr/local/bin/ - -DOCS_DIR=${DOCS_DIR:-docs} -INDEX_RST=${INDEX_RST:-index.rst} -BUILD_DIR=${BUILD_DIR:-docs_build} -OUTPUT_DIR=${OUTPUT_DIR:-docs_output} -SRC_DIR=${SRC_DIR:-$BUILD_DIR/_src} -VENV_DIR=${VENV_DIR:-$BUILD_DIR/_venv} -RELENG_DIR=${RELENG_DIR:-releng} -GERRIT_COMMENT=${GERRIT_COMMENT:-} - -get_title_script=" -import os -from docutils import core, nodes - -try: - with open('index.rst', 'r') as file: - data = file.read() - doctree = core.publish_doctree(data, - settings_overrides={'report_level': 5, - 'halt_level': 5}) - if isinstance(doctree[0], nodes.title): - title = doctree[0] - else: - for c in doctree.children: - if isinstance(c, nodes.section): - title = c[0] - break - print title.astext() -except: - print 'None'" -revision="$(git rev-parse --short HEAD)" -rev_full="$(git rev-parse HEAD)" -version="$(git describe --abbrev=0 2> /dev/null || echo draft) ($revision)" -project="$(basename $(git rev-parse --show-toplevel))" -html_notes=" Revision: $rev_full\n Build date: $(date -u +'%Y-%m-%d')" -default_conf='releng/docs/etc/conf.py' -opnfv_logo='releng/docs/etc/opnfv-logo.png' - -function check_rst_doc() { - _src="$1" - - # Note: This check may fail in many jobs for building project docs, since - # the old sample has lines more than 120. We ignore failures on this - # check right now, but these have to be fixed before OPNFV B release. - _out=$(doc8 --max-line-length 240 --ignore D000 "$_src") || { - _msg='Warning: rst validation (doc8) has failed, please fix the following error(s).' - _errs=$(echo "$_out" | sed -n -e "/^$_src/s/^/ /p") - echo - echo -e "$_msg\n$_errs" - echo - [[ -n "$GERRIT_COMMENT" ]] && echo -e "$_msg\n$_errs" >> "$GERRIT_COMMENT" - } -} - -function add_html_notes() { - _src="$1" - - find "$_src" -name '*.rst' | while read file - do - if grep -q -e ' _sha1_' "$file" ; then - # TODO: remove this, once old templates were removed from all repos. - echo - echo "Warn: '_sha1_' was found in [$file], use the latest document template." - echo " See https://wiki.opnfv.org/documentation/tools ." - echo - sed -i "s/ _sha1_/ $git_sha1/g" "$file" - fi - sed -i -e "\$a\\\n..\n$html_notes" "$file" - done -} - -function prepare_src_files() { - mkdir -p "$(dirname $SRC_DIR)" - - [[ -e "$SRC_DIR" ]] && rm -rf "$SRC_DIR" - cp -r "$DOCS_DIR" "$SRC_DIR" - add_html_notes "$SRC_DIR" -} - -function add_config() { - _conf="$1" - _param="$2" - _val="$3" - - if ! grep -q -e "^$_param = " "$_conf" ; then - echo "Adding '$_param' into $_conf ..." - echo "$_param = $_val" >> "$_conf" - fi -} - -function is_top_dir() { - [[ "$1" == "$DOCS_DIR" ]] -} - -function generate_name_for_top_dir() { - for suffix in '' '.top' '.all' '.master' '_' '__' '___' - do - _name="$(basename $DOCS_DIR)$suffix" - [[ -e "$DOCS_DIR/$_name" ]] && continue - echo "$_name" - return - done - - echo "Error: cannot find name for top directory [$DOCS_DIR]" - exit 1 -} - -function generate_name() { - _dir=$1 - - if is_top_dir "$_dir" ; then - _name=$(generate_name_for_top_dir $DOCS_DIR) - else - _name="${_dir#$DOCS_DIR/}" - fi - # Replace '/' by '_' - echo "${_name////_}" -} - - -check_rst_doc $DOCS_DIR - -if [[ ! -d "$RELENG_DIR" ]] ; then - echo "Error: $RELENG_DIR dir not found. See https://wiki.opnfv.org/documentation/tools ." - exit 1 -fi - -prepare_src_files - -if ! which virtualenv > /dev/null ; then - echo "Error: 'virtualenv' not found. Exec 'sudo pip install virtualenv' first." - exit 1 -fi - -virtualenv "$VENV_DIR" -source "$VENV_DIR/bin/activate" -pip install -r "$RELENG_DIR/docs/etc/requirements.txt" - -find $DOCS_DIR -name $INDEX_RST -printf '%h\n' | while read dir -do - name=$(generate_name $dir) - if is_top_dir "$dir" ; then - src="$SRC_DIR" - else - src="$SRC_DIR/${dir#$DOCS_DIR/}" - fi - build="$BUILD_DIR/$name" - output="$OUTPUT_DIR/$name" - conf="$src/conf.py" - - echo - echo "#################${dir//?/#}" - echo "Building DOCS in $dir" - echo "#################${dir//?/#}" - echo - - [[ ! -f "$conf" ]] && cp "$default_conf" "$conf" - title=$(cd $src; python -c "$get_title_script") - latex_conf="[('index', '$name.tex', \"$title\", 'OPNFV', 'manual'),]" - add_config "$conf" 'latex_documents' "$latex_conf" - add_config "$conf" 'release' "u'$version'" - add_config "$conf" 'version' "u'$version'" - add_config "$conf" 'project' "u'$project'" - add_config "$conf" 'copyright' "u'$(date +%Y), OPNFV'" - cp -f $opnfv_logo "$src/opnfv-logo.png" - - mkdir -p "$output" - - sphinx-build -b html -t html -E "$src" "$output" - - # Note: PDF creation may fail in project doc builds. - # We allow this build job to be marked as succeeded with - # failure in PDF creation, but leave message to fix it. - # Any failure has to be fixed before OPNFV B release. - { - sphinx-build -b latex -t pdf -E "$src" "$build" && \ - make -C "$build" LATEXOPTS='--interaction=nonstopmode' all-pdf - } && { - mv "$build/$name.pdf" "$output" - } || { - msg="Error: PDF creation for $dir has failed, please fix source rst file(s)." - echo - echo "$msg" - echo - [[ -n "$GERRIT_COMMENT" ]] && echo "$msg" >> "$GERRIT_COMMENT" - } - - # TODO: failures in ODT creation should be handled error and - # cause 'exit 1' before OPNFV B release. - tex=$(find $build -name '*.tex' | head -1) - odt="${tex%.tex}.odt" - if [[ -e $tex ]] && which pandoc > /dev/null ; then - ( - cd $(dirname $tex) - pandoc $(basename $tex) -o $(basename $odt) - ) && { - mv $odt $output/ - }|| { - msg="Error: ODT creation for $dir has failed." - echo - echo "$msg" - echo - } - else - echo "Warn: tex file and/or 'pandoc' are not found, skip ODT creation." - fi - - if is_top_dir "$dir" ; then - # NOTE: Having top level document (docs/index.rst) is not recommended. - # It may cause conflicts with other docs (mostly with HTML - # folders for contents in top level docs and other document - # folders). But, let's try merge of those contents into the top - # docs directory. - ( - cd $output - find . -type d -print | xargs -I d mkdir -p ../d - find . -type f -print | xargs -I f mv -b f ../f - ) - rm -rf "$output" - fi - -done - -deactivate diff --git a/utils/gpg_import_key.sh b/utils/gpg_import_key.sh index 3afeda839..80b7c397e 100644..100755 --- a/utils/gpg_import_key.sh +++ b/utils/gpg_import_key.sh @@ -40,3 +40,4 @@ else rm -f "$NODE_NAME"-subkey fi fi + diff --git a/utils/test/result_collection_api/update/README.md b/utils/test/result_collection_api/update/README.md index 41b7fffa3..d3aef7efe 100644 --- a/utils/test/result_collection_api/update/README.md +++ b/utils/test/result_collection_api/update/README.md @@ -1,59 +1,105 @@ -# opnfv-testapi update - -## How to use: - -# backup mongodb, -# arguments: -# -u/--url: Mongo DB URL, default = mongodb://127.0.0.1:27017/ -# -o/--output_dir: Output directory for the backup, default = ./ -# the backup output will be put under dir/db__XXXX_XX_XX_XXXXXX/db -# -d/--db: database for the backup, default = test_results_collection -``` -python backup.py -``` - -# restore mongodb -# arguments: -# -u/--url: Mongo DB URL, default = mongodb://127.0.0.1:27017/ -# -i/--input_dir: Input directory for the Restore, must be specified -# the restore input must be specified to dir/db__XXXX_XX_XX_XXXXXX/db -# -d/--db: database name after the restore, default = basename of input_dir -``` -python restore.py -``` - -# update mongodb -# arguments: -# -u/--url: Mongo DB URL, default = mongodb://127.0.0.1:27017/ -# -d/--db: database name to be updated, default = test_results_collection -# changes need to be done: -# change collection name, modify changes.collections_old2New -# collections_old2New = { -# 'old_collection': 'new_collection', -# } -# change field name, modify changes.fields_old2New -# fields_old2New = { -# 'collection': [(query, {'old_field': 'new_field'})] -# } -# change the doc, modify changes.docs_old2New -# docs_old2New = { -# 'test_results': [ -# ({'field': 'old_value'}, {'field': 'new_value'}), -# (query, {'field': 'new_value'}), -# ] -# } -``` -python update.py -``` - -# update opnfv-testapi process -# this script must be run right in this directory -# and remember to change ../etc/config.ini before running this script -# operations includes: -# kill running test_collection_api & opnfv-testapi -# install or update dependencies according to ../requirements.txt -# install opnfv-testapi -# run opnfv-testapi +Welcome to TESTAPI Update! +======================== + + +This file is used to describe how testapi update works + +---------- +How to use +--------------- + +#### <i class="icon-file"></i> backup mongodb + +arguments: +: -u/--url: Mongo DB URL, default = mongodb://127.0.0.1:27017/ +the backup output will be put under dir/db__XXXX_XX_XX_XXXXXX/db +-d/--db: database for the backup, default = test_results_collection + +usage: +``` +python backup_mongodb.py +``` + +#### <i class="icon-file"></i> restore mongodb + +arguments: +: -u/--url: Mongo DB URL, default = mongodb://127.0.0.1:27017/ + -i/--input_dir: Input directory for the Restore, must be specified, + the restore input must be specified to dir/db__XXXX_XX_XX_XXXXXX/db + -d/--db: database name after the restore, default = basename of input_dir + +usage: +``` +python restore_mongodb.py +``` +#### <i class="icon-file"></i> update mongodb + + arguments: +: -u/--url: Mongo DB URL, default = mongodb://127.0.0.1:27017/ + -d/--db: database name to be updated, default = test_results_collection + +changes need to be done: +change collection name, modify changes.collections_old2New + > collections_old2New = { + 'old_collection': 'new_collection', + } + + change field name, modify changes.fields_old2New + > fields_old2New = { + 'collection': [(query, {'old_field': 'new_field'})] + } + + change the doc, modify changes.docs_old2New + > docs_old2New = { + 'test_results': [ + ({'field': 'old_value'}, {'field': 'new_value'}), + (query, {'field': 'new_value'}), + ] + } + +#### <i class="icon-file"></i> update opnfv-testapi process +This script must be run right in this directory and remember to +change ../etc/config.ini before running this script. + +operations includes: +: kill running test_collection_api & opnfv-testapi +install or update dependencies according to ../requirements.txt +install opnfv-testapi +run opnfv-testapi + +usage: ``` python update_api.py ``` +#### <i class="icon-file"></i> update opnfv/testapi container +Here ansible-playbook is used to implement auto update. +Please make sure that the remote server is accessible via ssh. + +install ansible, please refer: +``` +http://docs.ansible.com/ansible/intro_installation.html +``` +run update.yml +arguments: +: host: remote server, must provide +user: user used to access to remote server, default to root +port: exposed port used to access to testapi, default to 8000 +image: testapi's docker image, default to opnfv/testapi:latest +update_path: templates directory in remote server, default to /tmp/testapi +mongodb_url: url of mongodb, default to 172.17.0.1, docker0 ip +swagger_url: swagger access url, default to http://host:port + +usage: +``` +ansible-playbook update.yml --extra-vars " +host=10.63.243.17 +user=zte +port=8000 +image=opnfv/testapi +update_path=/tmp/testapi +mongodb_url=mongodb://172.17.0.1:27017 +swagger_url=http://10.63.243.17:8000"``` +> **Note:** + +> - If documents need to be changed, please modify file +templates/changes_in_mongodb.py, and refer section **update mongodb** diff --git a/utils/test/result_collection_api/update/templates/__init__.py b/utils/test/result_collection_api/update/templates/__init__.py new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/utils/test/result_collection_api/update/templates/__init__.py diff --git a/utils/test/result_collection_api/update/backup.py b/utils/test/result_collection_api/update/templates/backup_mongodb.py index faa4fd410..7e0dd5545 100644 --- a/utils/test/result_collection_api/update/backup.py +++ b/utils/test/result_collection_api/update/templates/backup_mongodb.py @@ -6,9 +6,9 @@ # which accompanies this distribution, and is available at # http://www.apache.org/licenses/LICENSE-2.0 ############################################################################## -import os import argparse import datetime +import os from utils import execute, main, get_abspath diff --git a/utils/test/result_collection_api/update/changes.py b/utils/test/result_collection_api/update/templates/changes_in_mongodb.py index b3e23803d..b3e23803d 100644 --- a/utils/test/result_collection_api/update/changes.py +++ b/utils/test/result_collection_api/update/templates/changes_in_mongodb.py diff --git a/utils/test/result_collection_api/update/restore.py b/utils/test/result_collection_api/update/templates/restore_mongodb.py index c45a0e621..c45a0e621 100644 --- a/utils/test/result_collection_api/update/restore.py +++ b/utils/test/result_collection_api/update/templates/restore_mongodb.py diff --git a/utils/test/result_collection_api/update/templates/rm_olds.sh b/utils/test/result_collection_api/update/templates/rm_olds.sh new file mode 100644 index 000000000..c6bca1867 --- /dev/null +++ b/utils/test/result_collection_api/update/templates/rm_olds.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +proc_number=`ps -ef | grep opnfv-testapi | grep -v grep | wc -l` +if [ $proc_number -gt 0 ]; then + procs=`ps -ef | grep opnfv-testapi | grep -v grep` + echo "begin to kill opnfv-testapi $procs" + ps -ef | grep opnfv-testapi | grep -v grep | awk '{print $2}' | xargs kill -kill &>/dev/null +fi + +number=`docker ps -a | awk 'NR != 1' | grep testapi | wc -l` +if [ $number -gt 0 ]; then + containers=number=`docker ps -a | awk 'NR != 1' | grep testapi` + echo "begin to rm containers $containers" + docker ps -a | awk 'NR != 1' | grep testapi | awk '{print $1}' | xargs docker rm -f &>/dev/null +fi diff --git a/utils/test/result_collection_api/update/update.py b/utils/test/result_collection_api/update/templates/update_mongodb.py index 8b385a0b3..b1e378dd7 100644 --- a/utils/test/result_collection_api/update/update.py +++ b/utils/test/result_collection_api/update/templates/update_mongodb.py @@ -10,8 +10,8 @@ import argparse from pymongo import MongoClient +from changes_in_mongodb import collections_old2New, fields_old2New, docs_old2New from utils import main, parse_mongodb_url -from changes import collections_old2New, fields_old2New, docs_old2New parser = argparse.ArgumentParser(description='Update MongoDBs') diff --git a/utils/test/result_collection_api/update/utils.py b/utils/test/result_collection_api/update/templates/utils.py index a18ff0389..a18ff0389 100644 --- a/utils/test/result_collection_api/update/utils.py +++ b/utils/test/result_collection_api/update/templates/utils.py diff --git a/utils/test/result_collection_api/update/update.yml b/utils/test/result_collection_api/update/update.yml new file mode 100644 index 000000000..08839564a --- /dev/null +++ b/utils/test/result_collection_api/update/update.yml @@ -0,0 +1,41 @@ +--- +- hosts: "{{ host }}" + remote_user: "{{ user }}" + become: yes + become_method: sudo + vars: + user: "root" + port: "8000" + update_path: "/tmp/testapi" + image: "opnfv/testapi" + mongodb_url: "mongodb://172.17.0.1:27017" + swagger_url: "http://{{ host }}:{{ port }}" + tasks: + - name: create temporary update directory + file: + path: "{{ update_path }}" + state: directory + - name: transfer files in templates + copy: + src: templates/ + dest: "{{ update_path }}" + - name: backup mongodb database + command: "python {{ update_path }}/backup_mongodb.py -u {{ mongodb_url }} -o {{ update_path }}" + - name: stop and remove old versions + command: bash "{{ update_path }}/rm_olds.sh" + register: rm_result + - debug: msg="{{ rm_result.stderr }}" + - name: delete old docker images + command: docker rmi "{{ image }}" + ignore_errors: true + - name: update mongodb + command: "python {{ update_path }}/update_mongodb.py -u {{ mongodb_url }}" + - name: docker start testapi server + command: docker run -dti -p "{{ port }}:8000" + -e "mongodb_url={{ mongodb_url }}" + -e "swagger_url={{ swagger_url }}" + "{{ image }}" + - name: remove temporary update directory + file: + path: "{{ update_path }}" + state: absent
\ No newline at end of file |
