CI/CD pipeline basics in Django - Mini Project: Build & Apply

CI/CD Pipeline Basics with Django

📖 Scenario: You are working on a Django web application. To make your development faster and safer, you want to set up a simple CI/CD pipeline. This pipeline will automatically check your code and deploy it when you push changes.

🎯 Goal: Build a basic CI/CD pipeline configuration file that runs tests and deploys your Django app automatically.

📋 What You'll Learn

Create a YAML file named ci-cd-pipeline.yml for the pipeline configuration

Add a job to install dependencies using pip install -r requirements.txt

Add a job to run Django tests using python manage.py test

Add a job to deploy the app by printing Deploying Django app...

Use job dependencies so tests run after install, and deploy runs after tests

💡 Why This Matters

🌍 Real World

CI/CD pipelines are used in real projects to automatically test and deploy code changes, saving time and reducing errors.

💼 Career

Understanding CI/CD pipelines is essential for DevOps roles and software developers to deliver software quickly and reliably.

1

Create the initial pipeline file

Create a file named ci-cd-pipeline.yml and add a job called install that runs the command pip install -r requirements.txt.

Django

# Your code here

Hint

YAML files use indentation. Make sure script is indented under install, and the command is under script.

2

Add the test job

Add a job called test that runs python manage.py test. Make sure it depends on the install job.

Django

install:
  script:
    - pip install -r requirements.txt
# Add the test job below
# Your code here

Hint

Use needs to specify that test runs after install.

3

Add the deploy job

Add a job called deploy that prints Deploying Django app.... Make sure it depends on the test job.

Django

install:
  script:
    - pip install -r requirements.txt

test:
  script:
    - python manage.py test
  needs:
    - install
# Add the deploy job below
# Your code here

Hint

Use echo to print the deploy message in the script.

4

Print the pipeline jobs summary

Print the names of the jobs in order: install, test, and deploy separated by commas.

Django

install:
  script:
    - pip install -r requirements.txt

test:
  script:
    - python manage.py test
  needs:
    - install

deploy:
  script:
    - echo "Deploying Django app..."
  needs:
    - test

# Print the pipeline jobs below
# Your code here

Hint

Use print to show the job names separated by commas.

Practice

1. What is the main purpose of a CI/CD pipeline in a Django project?

easy

A. To automate testing and deployment for faster and safer code delivery

B. To manually review code changes before deployment

C. To write Django models automatically

D. To create database backups

Solution

1. Step 1: Understand CI/CD pipeline purpose

   A CI/CD pipeline automates the process of testing and deploying code changes to reduce errors and speed up delivery.

2. Step 2: Match purpose with options

   To automate testing and deployment for faster and safer code delivery correctly states automation of testing and deployment, which is the core of CI/CD pipelines.

3. Final Answer:

   To automate testing and deployment for faster and safer code delivery -> Option A

4. Quick Check:

   CI/CD automates testing and deployment = D [OK]

Hint: CI/CD means automating tests and deploys [OK]

Common Mistakes:

• Confusing CI/CD with manual code review
• Thinking CI/CD creates Django code automatically
• Assuming CI/CD is for backups

2. Which of the following is the correct syntax to define a job named test in a GitLab CI/CD pipeline YAML file?

easy

A. test:
script:
- python manage.py test

B. job test {
run: python manage.py test
}

C. - job: test
steps:
- script: python manage.py test

D. test => {
script: 'python manage.py test'
}

Solution

1. Step 1: Recall GitLab CI YAML job syntax

   GitLab CI jobs are defined as job_name: followed by script: list with commands.

2. Step 2: Compare options with correct YAML syntax

   test: script: - python manage.py test matches the correct YAML format for a job named test running the Django test command.

3. Final Answer:

   test:\n script:\n - python manage.py test -> Option A

4. Quick Check:

   GitLab CI job syntax uses job_name: and script: list = A [OK]

Hint: GitLab CI jobs use job_name: and script: list [OK]

Common Mistakes:

• Using curly braces or other languages syntax
• Missing the dash before script commands
• Confusing job syntax with other CI tools

3. Given this GitHub Actions workflow snippet for a Django project:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.12'
      - name: Install dependencies
        run: pip install -r requirements.txt
      - name: Run tests
        run: python manage.py test

What will happen when this workflow runs?

medium

A. The workflow will fail because Python version is not specified

B. The workflow will check out code, set Python 3.12, install dependencies, and run Django tests

C. The workflow will skip installing dependencies

D. The workflow will deploy the Django app automatically

Solution

1. Step 1: Analyze each step in the workflow

   The workflow checks out code, sets up Python 3.12, installs dependencies from requirements.txt, then runs Django tests.

2. Step 2: Confirm expected behavior

   All steps are valid and will run in order, so tests will execute after setup.

3. Final Answer:

   The workflow will check out code, set Python 3.12, install dependencies, and run Django tests -> Option B

4. Quick Check:

   Steps run in order: checkout, setup, install, test = A [OK]

Hint: Read steps top to bottom to predict workflow actions [OK]

Common Mistakes:

• Assuming Python version missing causes failure
• Thinking dependencies are skipped
• Confusing test run with deployment

4. You have this GitLab CI job snippet:

test:
  script:
    - python manage.py test
  only:
    - main
    - develop

But tests are not running on your feature branch pushes. What is the likely problem?

medium

A. The script command is incorrect

B. The pipeline YAML file is missing

C. The job is limited to run only on main and develop branches

D. The tests are skipped because of syntax error in Python code

Solution

1. Step 1: Understand the 'only' keyword in GitLab CI

   The 'only' keyword restricts job execution to specified branches, here main and develop only.

2. Step 2: Analyze why feature branches don't run tests

   Since feature branches are not listed, the job does not run on them.

3. Final Answer:

   The job is limited to run only on main and develop branches -> Option C

4. Quick Check:

   'only' limits branches = B [OK]

Hint: 'only' controls branches where job runs [OK]

Common Mistakes:

• Thinking script command is wrong without checking
• Assuming pipeline file is missing
• Blaming test code syntax without evidence

5. You want to create a CI/CD pipeline for your Django app that runs tests only if code changes affect models.py or views.py. Which GitLab CI configuration snippet correctly implements this?

hard

A. test:
script:
- python manage.py test
only:
refs:
- main
- develop

B. test:
script:
- python manage.py test
except:
changes:
- models.py
- views.py

C. test:
script:
- python manage.py test
when: manual

D. test:
script:
- python manage.py test
only:
changes:
- models.py
- views.py

Solution

1. Step 1: Understand 'only: changes' in GitLab CI

   This setting runs the job only if specified files change in the commit.

2. Step 2: Match requirement with options

   test: script: - python manage.py test only: changes: - models.py - views.py uses 'only: changes' with models.py and views.py, so tests run only if these files change.

3. Final Answer:

   test:\n script:\n - python manage.py test\n only:\n changes:\n - models.py\n - views.py -> Option D

4. Quick Check:

   'only: changes' triggers job on file changes = C [OK]

Hint: 'only: changes' runs job on specific file changes [OK]

Common Mistakes:

• Using 'except' instead of 'only' for changes
• Using branch refs instead of file changes
• Setting job to manual instead of automatic