Dockerfile

#############
# Dependencies
#
#  This base stage just installs the dependencies required for production
#  without any development deps.
ARG PYTHON_VER=3.11
FROM python:${PYTHON_VER} AS base

# Allow for flexible Python versions, for broader testing
ARG PYTHON_VER=3.11
ENV PYTHON_VERSION=${PYTHON_VER}
ENV DEBIAN_FRONTEND=noninteractive
RUN apt-get update -yqq && apt-get install -yqq shellcheck && apt-get clean

WORKDIR /usr/src/app

# Install Poetry manually via its installer script;
# if we instead used "pip install poetry" it would install its own dependencies globally which may conflict with ours.
# https://python-poetry.org/docs/master/#installing-with-the-official-installer
# This also makes it so that Poetry will *not* be included in the "final" image since it's not installed to /usr/local/
ARG POETRY_HOME=/opt/poetry
ARG POETRY_INSTALLER_PARALLEL=true
ARG POETRY_VERSION=2.1.3
ARG POETRY_VIRTUALENVS_CREATE=false
ADD https://install.python-poetry.org /tmp/install-poetry.py
RUN python /tmp/install-poetry.py

# Add poetry install location to the $PATH
ENV PATH="${POETRY_HOME}/bin:${PATH}"

RUN poetry config virtualenvs.create ${POETRY_VIRTUALENVS_CREATE} && \
    poetry config installer.parallel "${POETRY_INSTALLER_PARALLEL}"

# Bring in Poetry related files needed for other stages
COPY pyproject.toml poetry.lock ./

# Install only package Dependencies
RUN poetry install --only main

#########
# Linting
#
# Runs all necessary non Ansible linting and code checks
FROM base AS lint

ARG SKIP_LINT_TESTS
ENV SKIP_LINT_TESTS=${SKIP_LINT_TESTS}

# Install dev dependencies
RUN poetry install

# Copy in the application source and everything not explicitly banned by .dockerignore
COPY . .

RUN if [ "${SKIP_LINT_TESTS}" != "true" ]; then \
    echo 'Checking versions' && \
    invoke check-versions && \
    echo 'Running Ruff' && \
    ruff format . && \
    ruff check . && \
    echo 'Running Pylint' && \
    pylint **/*.py; \
    else \
    echo 'Skipping linting'; \
    fi

############
# Unit Tests
#
# This test stage runs true unit tests (no outside services) at build time, as
# well as enforcing codestyle and performing fast syntax checks. It is built
# into an image with docker-compose for running the full test suite.
FROM lint AS unittests

# Set a custom collection path for all ansible commands
# Note: This only allows for one path, not colon-separated, because we use it
# elsewhere
ARG ANSIBLE_COLLECTIONS_PATH=/usr/share/ansible/collections
ENV ANSIBLE_COLLECTIONS_PATH=${ANSIBLE_COLLECTIONS_PATH}

ARG PYTHON_VER=3.11
ENV PYTHON_VERSION=${PYTHON_VER}

# Allows for custom command line arguments to be passed to ansible-test (like -vvv)
ARG ANSIBLE_SANITY_ARGS
ENV ANSIBLE_SANITY_ARGS=${ANSIBLE_SANITY_ARGS}
ARG ANSIBLE_UNIT_ARGS
ENV ANSIBLE_UNIT_ARGS=${ANSIBLE_UNIT_ARGS}
ARG SKIP_SANITY_TESTS
ENV SKIP_SANITY_TESTS=${SKIP_SANITY_TESTS}
ARG SKIP_UNIT_TESTS
ENV SKIP_UNIT_TESTS=${SKIP_UNIT_TESTS}

# For Module unit tests as we use some testing features available in these collections
RUN ansible-galaxy collection install community.general community.internal_test_tools

# Build Collection to run ansible-tests against
RUN ansible-galaxy collection build --output-path ./dist/ .

# Install built library
RUN ansible-galaxy collection install ./dist/networktocode*.tar.gz -p ${ANSIBLE_COLLECTIONS_PATH}

# Switch to the collection path for tests
WORKDIR ${ANSIBLE_COLLECTIONS_PATH}/ansible_collections/networktocode/nautobot

# Run sanity tests
RUN if [ "${SKIP_SANITY_TESTS}" != "true" ]; then \
    echo 'Running Ansible Sanity Tests.' && \
    ansible-test sanity $ANSIBLE_SANITY_ARGS \
    --requirements \
    --python ${PYTHON_VER} && \
    echo 'Running Ansible Lint' && \
    ansible-lint; \
    else \
    echo 'Skipping sanity tests'; \
    fi

# Run unit tests
RUN if [ "${SKIP_UNIT_TESTS}" != "true" ]; then \
    echo 'Running Ansible Unit Tests.' && \
    ansible-test units $ANSIBLE_UNIT_ARGS --coverage --requirements --python ${PYTHON_VERSION}; \
    else \
    echo 'Skipping unit tests'; \
    fi

############
# Integration Tests
FROM unittests AS integration

ARG ANSIBLE_INTEGRATION_ARGS
ENV ANSIBLE_INTEGRATION_ARGS=${ANSIBLE_INTEGRATION_ARGS}
ARG SKIP_INVENTORY_TESTS
ENV SKIP_INVENTORY_TESTS=${SKIP_INVENTORY_TESTS}
ARG SKIP_REGRESSION_TESTS
ENV SKIP_REGRESSION_TESTS=${SKIP_REGRESSION_TESTS}
ARG NAUTOBOT_VER
ENV NAUTOBOT_VER=${NAUTOBOT_VER}

# Integration test entrypoint
ENTRYPOINT ${ANSIBLE_COLLECTIONS_PATH}/ansible_collections/networktocode/nautobot/tests/integration/entrypoint.sh

CMD ["--help"]