Merge pull request #1661 from pavelpicka/6312-docs-workflow-update

Independent docs script
pulp · Apr 21, 2020 · 613aede · 613aede
2 parents ee108c1 + 722b9aa
commit 613aede
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 9 deletions.
diff --git a/CHANGES/6312.misc b/CHANGES/6312.misc
@@ -0,0 +1 @@
+Docs check scripts can run together.
diff --git a/docs/_scripts/artifact.sh b/docs/_scripts/artifact.sh
@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
 # Get an RPM package
-curl -O https://repos.fedorapeople.org/pulp/pulp/fixtures/rpm/fox-1.1-2.noarch.rpm
-export PKG="fox-1.1-2.noarch.rpm"
+curl -O https://repos.fedorapeople.org/pulp/pulp/fixtures/rpm-signed/squirrel-0.1-1.noarch.rpm
+export PKG="squirrel-0.1-1.noarch.rpm"
 
 # Upload it as an Artifact
 echo "Upload an RPM package."

diff --git a/docs/_scripts/distribution.sh b/docs/_scripts/distribution.sh
@@ -1,8 +1,15 @@
 #!/usr/bin/env bash
 
+# Variables
+if [ $# -eq 0 ]; then
+  export BASE_PATH="foo"
+else
+  export BASE_PATH="$1"
+fi
+
 # Create RPM distribution for publication
 export TASK_URL=$(http POST $BASE_ADDR/pulp/api/v3/distributions/rpm/rpm/ \
-    name='baz' base_path='foo' publication=$PUBLICATION_HREF | jq -r '.task')
+    publication=$PUBLICATION_HREF name="$BASE_PATH" base_path="$REPO_NAME" | jq -r '.task')
 
 # Poll the task (here we use a function defined in docs/_scripts/base.sh)
 wait_until_task_finished $BASE_ADDR$TASK_URL

diff --git a/docs/_scripts/docs_check_sync.sh b/docs/_scripts/docs_check_sync.sh
@@ -8,13 +8,16 @@
 # From the _scripts directory, run with `source docs_check_sync_publish.sh` (source to preserve the
 # environment variables)
 
+export REPO_NAME="sync-repo"
+export DIST_NAME="sync-dist"
+
 source base.sh
 
-source repo.sh
+source repo.sh "$REPO_NAME"
 source remote.sh
 source sync.sh
 
 source publication.sh
-source distribution.sh
+source distribution.sh "$DIST_NAME"
 
 source download.sh
diff --git a/docs/_scripts/docs_check_upload.sh b/docs/_scripts/docs_check_upload.sh
@@ -8,8 +8,11 @@
 # From the _scripts directory, run with `source docs_check_upload_publish.sh` (source to preserve
 # the environment variables)
 
+export REPO_NAME="upload-repo"
+export DIST_NAME="upload-dist"
+
 source base.sh
-source repo.sh
+source repo.sh "$REPO_NAME"
 
 source artifact.sh
 source package.sh
@@ -18,5 +21,5 @@ source advisory.sh
 source copy.sh
 
 source publication.sh
-source distribution.sh
+source distribution.sh "$DIST_NAME"
 source download.sh
diff --git a/docs/_scripts/download.sh b/docs/_scripts/download.sh
@@ -3,7 +3,9 @@
 # Download a package
 
 # Specify one package from repository used in 'remote.sh'
-PKG="fox-1.1-2.noarch.rpm"
+if [ -z "$PKG" ]; then
+  PKG="fox-1.1-2.noarch.rpm"
+fi
 
 # The distribution will return a url that can be used by http clients
 echo "Setting DISTRIBUTION_BASE_URL, which is used to retrieve content from the content app."

diff --git a/docs/_scripts/repo.sh b/docs/_scripts/repo.sh
@@ -1,7 +1,11 @@
 #!/usr/bin/env bash
 
 # Create RPM repository
-export REPO_NAME="foo"
+if [ $# -eq 0 ]; then
+  export REPO_NAME="foo"
+else
+  export REPO_NAME="$1"
+fi
 
 echo "Creating a new repository named $REPO_NAME."
 export REPO_HREF=$(http POST $BASE_ADDR/pulp/api/v3/repositories/rpm/rpm/ name=$REPO_NAME \

diff --git a/docs/workflows/scripting.rst b/docs/workflows/scripting.rst
@@ -5,6 +5,9 @@ Each workflow renders bash scripts that allow the developers to ensure the conti
 the instructions. These scripts may also be helpful to users as a basis for their own scripts. All
 of the scripts can be found at https://github.com/pulp/pulp_rpm/tree/master/docs/_scripts/
 
+Some scripts have conditional statements for setting REPO_NAME.
+These are used by Pulp team for validity testing.
+
 The following scripts are used in conjunction with all the workflow scripts:
 
 **Base**