Migrate To Ansible Collection

.github/workflows/ansible-test.yml

@@ -0,0 +1,198 @@
+# README FIRST
+# 1. replace "NAMESPACE" and "COLLECTION_NAME" with the correct name in the env section (e.g. with 'community' and 'mycollection')
+# 2. If you don't have unit tests remove that section
+# 3. If your collection depends on other collections ensure they are installed, see "Install collection dependencies"
+# If you need help please ask in #ansible-devel on Freenode IRC
+
+name: CI
+on:
+  # Run CI against all pushes (direct commits, also merged PRs), Pull Requests
+  push:
+  pull_request:
+  # Run CI once per day (at 06:00 UTC)
+  # This ensures that even if there haven't been commits that we are still testing against latest version of ansible-test for each ansible-base version
+  schedule:
+    - cron: '0 6 * * *'
+env:
+  NAMESPACE: cisco
+  COLLECTION_NAME: ftdansible 
+
+jobs:
+
+###
+# Check Build
+#
+
+
+  build:
+    name: Build collection
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ansible: [2.9.17, 2.10.5]
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install ansible-base (v${{ matrix.ansible }})
+      run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+
+    - name: Build a collection tarball
+      run: pwd && ls -al && find . && ansible-galaxy collection build --output-path "${GITHUB_WORKSPACE}/.cache/collection-tarballs"
+
+    - name: Store migrated collection artifacts
+      uses: actions/upload-artifact@v1
+      with:
+        name: collection
+        path: .cache/collection-tarballs
+
+###
+# Check Importer
+#
+
+  importer:
+    name: Galaxy-importer check
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install ansible-base (v2.11.0)
+      run: pip install https://github.com/ansible/ansible/archive/v2.11.0.tar.gz --disable-pip-version-check
+
+    - name: Download migrated collection artifacts
+      uses: actions/download-artifact@v1
+      with:
+        name: collection
+        path: .cache/collection-tarballs
+
+    - name: Install the collection tarball
+      run: ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
+
+    - name: Install galaxy-importer
+      run: pip install galaxy-importer
+
+    - name: Create galaxy-importer directory
+      run: sudo mkdir -p /etc/galaxy-importer
+
+    - name: Create galaxy-importer.cfg
+      run: sudo cp /home/runner/.ansible/collections/ansible_collections/cisco/ftdansible/.github/workflows/galaxy-importer.cfg /etc/galaxy-importer/galaxy-importer.cfg
+
+    - name: Run galaxy-importer check
+      run: python -m galaxy_importer.main .cache/collection-tarballs/cisco-*.tar.gz | tee .cache/collection-tarballs/log.txt && sudo cp ./importer_result.json .cache/collection-tarballs/importer_result.json
+
+    - name: Check warnings and errors
+      run: if grep -E 'ERROR' .cache/collection-tarballs/log.txt; then exit 1; else exit 0; fi
+
+    - name: Store galaxy_importer check log file
+      uses: actions/upload-artifact@v1
+      with:
+        name: galaxy-importer-log
+        path: .cache/collection-tarballs/importer_result.json
+
+###
+# Sanity tests (REQUIRED)
+#
+# https://docs.ansible.com/ansible/latest/dev_guide/testing_sanity.html
+
+  sanity:
+    name: Sanity (Ⓐ${{ matrix.ansible }})
+    strategy:
+      matrix:
+        ansible:
+          - stable-2.9
+          - stable-2.10
+          # It's important that Sanity is tested against all stable-X.Y branches
+          # Testing against `devel` may fail as new tests are added.
+          # - stable-2.9 # Only if your collection supports Ansible 2.9
+    runs-on: ubuntu-latest
+    steps:
+
+      # ansible-test requires the collection to be in a directory in the form
+      # .../ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}/
+
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          # it is just required to run that once as "ansible-test sanity" in the docker image
+          # will run on all python versions it supports.
+          python-version: 3.8
+
+      # Install the head of the given branch (devel, stable-2.10)
+      - name: Install ansible-base (${{ matrix.ansible }})
+        run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+
+      - name: Run sanity tests
+        run: ansible-test sanity --docker -v --color
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      # ansible-test support producing code coverage date
+      - name: Generate coverage report
+        # run: ansible-test coverage xml -v --requirements --group-by command --group-by version
+        run: ansible-test coverage xml -v --requirements --group-by command --group-by version
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      # See the reports at https://codecov.io/gh/GITHUBORG/REPONAME
+      - uses: codecov/codecov-action@v1
+        with:
+          fail_ci_if_error: false
+
+###
+# Unit tests (REQUIRED)
+#
+# https://docs.ansible.com/ansible/latest/dev_guide/testing_sanity.html
+
+  units:
+    name: Unit (Ⓐ${{ matrix.ansible }})
+    strategy:
+      matrix:
+        ansible:
+          - stable-2.9
+          - stable-2.10
+          # It's important that Sanity is tested against all stable-X.Y branches
+          # Testing against `devel` may fail as new tests are added.
+          # - stable-2.9 # Only if your collection supports Ansible 2.9
+    runs-on: ubuntu-latest
+    steps:
+
+      # ansible-test requires the collection to be in a directory in the form
+      # .../ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}/
+
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          path: ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          # it is just required to run that once as "ansible-test sanity" in the docker image
+          # will run on all python versions it supports.
+          python-version: 3.8
+
+      # Install the head of the given branch (devel, stable-2.10)
+      - name: Install ansible-base (${{ matrix.ansible }})
+        run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+
+      # Install units
+      # - name: Install units
+      #   run: pip install units
+
+      # Run the unit tests on python 3.5
+      - name: Run unit tests
+        run: ansible-test units --docker -v --color
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}

.github/workflows/galaxy-importer.cfg

@@ -0,0 +1,9 @@
+[galaxy-importer]
+LOG_LEVEL_MAIN = INFO
+RUN_FLAKE8 = True
+RUN_ANSIBLE_DOC = True
+RUN_ANSIBLE_LINT = True
+RUN_ANSIBLE_TEST = False
+ANSIBLE_TEST_LOCAL_IMAGE = False
+LOCAL_IMAGE_DOCKER = False
+INFRA_OSD = False

.gitignore

@@ -58,3 +58,5 @@ venv.bak/
 
 # Doc distribution folder
 docs/dist
+workspace/
+tests/output

CHANGELOG.rst

@@ -0,0 +1,9 @@
+==============================
+Cisco.Ftdansible Release Notes
+==============================
+
+.. contents:: Topics
+
+
+v0.3.0
+======

Dockerfile

@@ -1,21 +1,19 @@
 ARG PYTHON_VERSION=3.6
 FROM python:${PYTHON_VERSION}
-ARG FTD_ANSIBLE_VERSION=v0.3.1
+ARG FTD_ANSIBLE_VERSION=v0.4.1236
 ARG FTD_ANSIBLE_FOLDER=ftd-ansible
 
 RUN apt-get update && \
     apt-get install -yq sshpass && \
     rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
-RUN wget https://github.com/CiscoDevNet/FTDAnsible/archive/${FTD_ANSIBLE_VERSION}.tar.gz && \
-    tar -xvf ${FTD_ANSIBLE_VERSION}.tar.gz
+RUN wget https://github.com/meignw2021/FTDAnsible/archive/refs/tags/${FTD_ANSIBLE_VERSION}.tar.gz && \
+    tar -xvf ${FTD_ANSIBLE_VERSION}.tar.gz 
 
-RUN mkdir /${FTD_ANSIBLE_FOLDER}/ && \
-    export FTD_SOURCE_FOLDER=`find ./ -maxdepth 1 -type d -name '*FTDAnsible-*'` && \
-    mv $FTD_SOURCE_FOLDER/httpapi_plugins /${FTD_ANSIBLE_FOLDER} && \
-    mv $FTD_SOURCE_FOLDER/library /${FTD_ANSIBLE_FOLDER} && \
-    mv $FTD_SOURCE_FOLDER/module_utils /${FTD_ANSIBLE_FOLDER} && \
-    mv $FTD_SOURCE_FOLDER/requirements.txt /${FTD_ANSIBLE_FOLDER} && \
+RUN mkdir -p /${FTD_ANSIBLE_FOLDER}/ 
+RUN export FTD_SOURCE_FOLDER=`find ./ -maxdepth 1 -type d -name '*FTDAnsible-*'` && \
+    mv $FTD_SOURCE_FOLDER/ansible_collections /${FTD_ANSIBLE_FOLDER}/ && \
+    mv $FTD_SOURCE_FOLDER/requirements.txt /${FTD_ANSIBLE_FOLDER}/ && \
     mv $FTD_SOURCE_FOLDER/ansible.cfg  /${FTD_ANSIBLE_FOLDER}
 
 RUN pip install --no-cache-dir -r /${FTD_ANSIBLE_FOLDER}/requirements.txt

Dockerfile.ansible29.tests

@@ -0,0 +1,28 @@
+ARG PYTHON_VERSION=3.6
+FROM python:${PYTHON_VERSION}
+
+COPY requirements.ansible29.txt /requirements.txt
+
+RUN pip download $(grep ^ansible ./requirements.txt) --no-cache-dir --no-deps -d /tmp/pip && \
+    mkdir /tmp/ansible && \
+    tar -C /tmp/ansible -xf /tmp/pip/ansible* && \
+    mv /tmp/ansible/ansible* /ansible && \
+    rm -rf /tmp/pip /tmp/ansible
+
+COPY test-requirements.txt /test-requirements.txt
+
+RUN pip install \
+    --no-cache-dir \
+    -c /ansible/test/lib/ansible_test/_data/requirements/constraints.txt \
+    -r /test-requirements.txt \
+    -r /requirements.txt
+
+ENV PYTHONPATH="$PYTHONPATH:/ansible/lib:/ansible/test"
+
+COPY . /ftd-ansible
+
+WORKDIR /ftd-ansible
+
+ENTRYPOINT ["pytest"]
+
+CMD ["test"]

Dockerfile.tests

@@ -13,11 +13,11 @@ COPY test-requirements.txt /test-requirements.txt
 
 RUN pip install \
     --no-cache-dir \
-    -c /ansible/test/runner/requirements/constraints.txt \
+    -c /ansible/ansible_collections/community/general/tests/utils/constraints.txt \
     -r /test-requirements.txt \
     -r /requirements.txt
 
-ENV PYTHONPATH="$PYTHONPATH:/ansible/lib:/ansible/test"
+ENV PYTHONPATH="$PYTHONPATH:/ftd-ansible/ansible/lib:/ftd-ansible/ansible/test"
 
 COPY . /ftd-ansible
 
@@ -26,3 +26,4 @@ WORKDIR /ftd-ansible
 ENTRYPOINT ["pytest"]
 
 CMD ["test"]
+

Dockerfile_integration

@@ -0,0 +1,28 @@
+ARG PYTHON_VERSION=3.6
+FROM python:${PYTHON_VERSION}
+ARG FTD_ANSIBLE_VERSION=v0.4.1236
+ARG FTD_ANSIBLE_FOLDER=/root/ansible_collections/cisco/ftdansible
+
+RUN apt-get update && \
+    apt-get install -yq sshpass && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+RUN mkdir -p ${FTD_ANSIBLE_FOLDER}/ 
+
+RUN ls -al /tmp
+
+COPY requirements.txt ${FTD_ANSIBLE_FOLDER}/
+RUN pip install --no-cache-dir -r /${FTD_ANSIBLE_FOLDER}/requirements.txt
+
+COPY test-requirements.txt ${FTD_ANSIBLE_FOLDER}/
+COPY galaxy.yml ${FTD_ANSIBLE_FOLDER}/
+COPY meta ${FTD_ANSIBLE_FOLDER}/meta
+COPY plugins ${FTD_ANSIBLE_FOLDER}/plugins
+COPY samples ${FTD_ANSIBLE_FOLDER}/samples
+COPY tests ${FTD_ANSIBLE_FOLDER}/tests
+
+
+ENV PYTHONPATH="$PYTHONPATH:/${FTD_ANSIBLE_FOLDER}/"
+WORKDIR /${FTD_ANSIBLE_FOLDER}
+ENTRYPOINT ["ansible-playbook"]
+# CMD ["bash"]