ساخت Pipeline برای تست و دیپلوی با پایتون

در دنیای توسعه نرم‌افزار مدرن، تحویل سریع و قابل اعتماد نرم‌افزار به کاربران، امری حیاتی است. Pipelineهای تست و دیپلوی (CI/CD) نقش کلیدی در این فرآیند ایفا می‌کنند. این مقاله به بررسی نحوه ساخت یک pipeline کامل برای تست و دیپلوی برنامه‌های پایتونی می‌پردازد. هدف این آموزش، ارائه یک دیدگاه عملی و قابل استفاده برای توسعه‌دهندگان پایتون است که به دنبال خودکارسازی فرآیند تحویل نرم‌افزار خود هستند.

مقدمه بر CI/CD

CI/CD مخفف Continuous Integration (ادغام مداوم) و Continuous Delivery/Deployment (تحویل/دیپلوی مداوم) است. ادغام مداوم به فرآیند ادغام مکرر تغییرات کد از چندین توسعه‌دهنده در یک مخزن مرکزی اشاره دارد. این فرآیند معمولاً شامل اجرای خودکار تست‌ها برای اطمینان از اینکه تغییرات جدید، کد موجود را خراب نمی‌کنند، می‌شود. تحویل مداوم، فرآیند خودکارسازی انتشار تغییرات کد به یک محیط استیجینگ (staging) یا پیش‌تولید است. دیپلوی مداوم، یک گام فراتر رفته و تغییرات کد را به طور خودکار به محیط تولید دیپلوی می‌کند.

ابزارهای مورد نیاز

برای ساخت یک pipeline CI/CD، به ابزارهای مختلفی نیاز داریم. در این آموزش، از ابزارهای زیر استفاده خواهیم کرد:

• Git: برای مدیریت نسخه کد.
• GitHub/GitLab/Bitbucket: به عنوان مخزن کد و پلتفرم CI/CD.
• Python: زبان برنامه‌نویسی مورد استفاده.
• pytest: فریم‌ورک تست پایتون.
• Docker: برای کانتینریزه کردن برنامه.
• Docker Hub/Container Registry: برای ذخیره تصاویر Docker.
• سرور: برای دیپلوی برنامه (می‌تواند یک سرور مجازی، Kubernetes یا یک سرویس ابری باشد).

مراحل ساخت Pipeline

Pipeline ما شامل مراحل زیر خواهد بود:

1. Pull Request: توسعه‌دهنده یک Pull Request (PR) ایجاد می‌کند تا تغییرات خود را برای بررسی به مخزن اصلی ارسال کند.
2. Build: سیستم CI/CD کد را از مخزن دریافت می‌کند و آن را build می‌کند. این مرحله ممکن است شامل نصب وابستگی‌ها، linting کد و اجرای تست‌های استاتیک باشد.
3. Test: سیستم CI/CD تست‌های واحد (unit tests) و تست‌های یکپارچگی (integration tests) را اجرا می‌کند.
4. Containerize: سیستم CI/CD یک تصویر Docker از برنامه ایجاد می‌کند.
5. Push Image: تصویر Docker به یک رجیستری تصویر (مانند Docker Hub) push می‌شود.
6. Deploy: سیستم CI/CD تصویر Docker را به سرور دیپلوی می‌کند.

پیاده‌سازی Pipeline

۱. ساختار پروژه

ابتدا، یک ساختار پروژه مناسب ایجاد می‌کنیم:

my_project/
├── app/
│   ├── __init__.py
│   ├── main.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_main.py
│   └── ...
├── Dockerfile
├── requirements.txt
└── .github/workflows/
    └── main.yml

۲. نوشتن تست‌ها

تست‌های خود را با استفاده از pytest بنویسید. به عنوان مثال، یک تست ساده:

# tests/test_main.py
def test_addition():
    assert 1 + 1 == 2

۳. Dockerfile

یک Dockerfile برای کانتینریزه کردن برنامه خود ایجاد کنید:

# Dockerfile
FROM python:3.9-slim-buster

WORKDIR /app

COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

COPY . .

CMD ["python", "app/main.py"]

۴. فایل Workflow (main.yml)

یک فایل workflow در دایرکتوری `.github/workflows` ایجاد کنید. این فایل، pipeline CI/CD را تعریف می‌کند:

# .github/workflows/main.yml
name: CI/CD Pipeline

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'
      - name: Install dependencies
        run: pip install --no-cache-dir -r requirements.txt
      - name: Run tests
        run: pytest
      - name: Build Docker image
        run: docker build -t my-app .
      - name: Login to Docker Hub
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
      - name: Push Docker image
        run: docker push my-app
      - name: Deploy to Server
        run: |
          # Add your deployment commands here
          # For example, using SSH to connect to the server and pull the latest image
          ssh user@server "docker pull my-app && docker stop my-app && docker rm my-app && docker run -d -p 80:80 my-app"

نکات مهم در فایل workflow:

• `on:` مشخص می‌کند که این workflow چه زمانی اجرا شود (در اینجا، با push به branch `main` و ایجاد Pull Request).
• `jobs:` مجموعه‌ای از jobها را تعریف می‌کند.
• `steps:` مجموعه‌ای از مراحل را در هر job تعریف می‌کند.
• `uses:` از اکشن‌های از پیش ساخته شده استفاده می‌کند (مانند `actions/checkout@v3` برای checkout کردن کد).
• `run:` دستورات shell را اجرا می‌کند.
• `secrets:` از secrets برای ذخیره اطلاعات حساس (مانند نام کاربری و توکن Docker Hub) استفاده می‌کند.

۵. پیکربندی Secrets

در تنظیمات مخزن GitHub خود، secrets `DOCKERHUB_USERNAME` و `DOCKERHUB_TOKEN` را با نام کاربری و توکن Docker Hub خود پیکربندی کنید.

۶. دیپلوی به سرور

در مرحله `Deploy to Server`، دستورات لازم برای دیپلوی برنامه به سرور خود را اضافه کنید. این ممکن است شامل اتصال به سرور از طریق SSH، pull کردن آخرین تصویر Docker، stop کردن کانتینر قبلی، حذف کانتینر قبلی و run کردن کانتینر جدید باشد.

بهبود Pipeline

Pipeline بالا یک مثال ساده است. می‌توانید آن را با افزودن مراحل زیر بهبود دهید:

• Linting: استفاده از ابزارهایی مانند flake8 یا pylint برای بررسی کیفیت کد.
• Static Analysis: استفاده از ابزارهایی مانند SonarQube برای تجزیه و تحلیل کد و شناسایی مشکلات امنیتی و باگ‌ها.
• Code Coverage: محاسبه میزان پوشش کد توسط تست‌ها.
• Staging Environment: دیپلوی برنامه به یک محیط استیجینگ قبل از دیپلوی به محیط تولید.
• Rollback: امکان بازگشت به نسخه قبلی برنامه در صورت بروز مشکل.
• Monitoring: نظارت بر عملکرد برنامه در محیط تولید.

نتیجه‌گیری

ساخت یک pipeline CI/CD برای برنامه‌های پایتونی، فرآیند تحویل نرم‌افزار را خودکار می‌کند و به شما کمک می‌کند تا نرم‌افزار با کیفیت‌تری را سریع‌تر و قابل اعتمادتر به کاربران خود ارائه دهید. با استفاده از ابزارها و تکنیک‌های ارائه شده در این مقاله، می‌توانید یک pipeline CI/CD سفارشی برای نیازهای خاص خود ایجاد کنید.