X Tutup
Skip to content

Latest commit

 

History

History
159 lines (112 loc) · 4.67 KB

README-Docker.md

File metadata and controls

159 lines (112 loc) · 4.67 KB

Docker Test Environment for python-mode

This directory contains Docker configuration to run python-mode tests locally. Note: Docker is only used for local development. CI tests run directly in GitHub Actions without Docker.

Prerequisites

  • Docker
  • Docker Compose

Quick Start

Run Tests

To run all tests in Docker (default version 3.13.0):

# Using the convenience script
./scripts/user/run-tests-docker.sh

# Or manually with docker-compose
docker compose run --rm python-mode-tests

Interactive Development

To start an interactive shell for development:

docker compose run --rm python-mode-dev

What's Included

The Docker environment includes:

  • Ubuntu 24.04 base image
  • pyenv for Python version management
  • Multiple Python versions: 3.10.13, 3.11.9, 3.12.4, 3.13.0
  • Python 3.13.0 as default
  • Vim built from source with Python support for each Python version
  • All required system dependencies:
    • GUI libraries (GTK, X11, etc.)
    • Lua 5.2
    • Perl
    • Build tools
    • Python build dependencies
  • python-mode plugin properly installed and configured
  • Git submodules initialized
  • Test environment matching the CI setup

Environment Details

The container replicates the GitHub Actions environment:

  • Vim is built with --enable-python3interp=yes for each Python version
  • pyenv is installed at /opt/pyenv
  • Python versions are managed by pyenv:
    • 3.10.13
    • 3.11.9
    • 3.12.4
    • 3.13.0 (default)
  • Each Python version has its own Vim binary: vim-3.10.13, vim-3.11.9, etc.
  • Python config directory is automatically detected using python-config --configdir
  • python-mode is installed in /root/.vim/pack/foo/start/python-mode
  • Test configuration files are copied to the appropriate locations
  • All required environment variables are set

Test Execution

Local Testing (Docker)

Tests are run using the Vader test framework via Docker Compose:

# Using docker compose directly
docker compose run --rm python-mode-tests

# Or using the convenience script
./scripts/user/run-tests-docker.sh

# Or using the Vader test runner script
./scripts/user/run_tests.sh

CI Testing (Direct Execution)

In GitHub Actions CI, tests run directly without Docker using scripts/cicd/run_vader_tests_direct.sh. This approach:

  • Runs 3-5x faster (no Docker build/pull overhead)
  • Provides simpler debugging (direct vim output)
  • Uses the same Vader test suite for consistency

Vader Test Suites:

  • autopep8.vader - Tests automatic code formatting (8/8 tests passing)
  • commands.vader - Tests Vim commands and autocommands (7/7 tests passing)
  • folding.vader - Tests code folding functionality
  • lint.vader - Tests linting functionality
  • motion.vader - Tests motion operators
  • rope.vader - Tests Rope refactoring features
  • simple.vader - Basic functionality tests
  • textobjects.vader - Tests text object operations

All legacy bash tests have been migrated to Vader tests.

Testing with Different Python Versions

You can test python-mode with different Python versions:

# Test with Python 3.11.9
./scripts/user/run-tests-docker.sh 3.11

# Test with Python 3.12.4
./scripts/user/run-tests-docker.sh 3.12

# Test with Python 3.13.0
./scripts/user/run-tests-docker.sh 3.13

Available Python versions: 3.10.13, 3.11.9, 3.12.4, 3.13.0

Note: Use the major.minor format (e.g., 3.11) when specifying versions.

Troubleshooting

Python Config Directory Issues

The Dockerfile uses python-config --configdir to automatically detect the correct Python config directory. If you encounter issues:

  1. Check that pyenv is properly initialized
  2. Verify that the requested Python version is available
  3. Ensure all environment variables are set correctly

Build Failures

If the Docker build fails:

  1. Check that all required packages are available in Ubuntu 24.04
  2. Verify that pyenv can download and install Python versions
  3. Ensure the Vim source code is accessible
  4. Check that pyenv is properly initialized in the shell

Test Failures

If tests fail in Docker but pass locally:

  1. Check that the Vim build includes Python support for the correct version
  2. Verify that all git submodules are properly initialized
  3. Ensure the test environment variables are correctly set
  4. Confirm that the correct Python version is active
  5. Verify that pyenv is properly initialized

Adding More Python Versions

To add support for additional Python versions:

  1. Add the new version to the PYTHON_VERSION arg in the Dockerfile
  2. Update the test scripts to include the new version
  3. Test that the new version works with the python-mode plugin
  4. Update this documentation with the new version information
X Tutup