From 99991a3729120a1e2e8a3cb88abb75268c2e6245 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Sat, 21 Jul 2018 09:02:47 +0200 Subject: [PATCH] Use Docker for easier test running (#86) Switches to CircleCI instead of Travis, which handles running tests in Docker much better, especially since Travis is really slow (~30min vs 2.5min on CircleCI). The Docker image is based on https://github.com/tweekmonster/vim-testbed, and targets are added to the Makefile to build/push it. --- .circleci/config.yml | 31 +++++++++++++++++++++++++++++++ .dockerignore | 4 ++++ .travis.yml | 15 --------------- CONTRIBUTING.rst | 8 ++++++++ Dockerfile | 19 +++++++++++++++++++ Makefile | 20 ++++++++++++++++++++ docker-compose.yml | 6 ++++++ 7 files changed, 88 insertions(+), 15 deletions(-) create mode 100644 .circleci/config.yml create mode 100644 .dockerignore delete mode 100644 .travis.yml create mode 100644 Dockerfile create mode 100644 docker-compose.yml diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..bc0bd36 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,31 @@ +version: 2 + +jobs: + test: + docker: + - image: blueyed/vim-python-pep8-indent-vims-for-test:1@sha256:8c77867e1fdf673a6df0ecf6628f8e4d80579a0a097ec196109ca0bc145d86c0 + steps: + - checkout + - run: + name: Run tests + command: | + Xvfb :99 & + DISPLAY=:99 VIMRUNNER_REUSE_SERVER=1 rspec spec + + checkqa: + docker: + - image: circleci/python:3.7 + steps: + - checkout + - run: + name: Lint + command: | + pip install --user vim-vint + ~/.local/bin/vint **/*.vim + +workflows: + version: 2 + test: + jobs: + - test + - checkqa diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..8a03768 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,4 @@ +* +!Gemfile +!indent +!spec diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 9c9641c..0000000 --- a/.travis.yml +++ /dev/null @@ -1,15 +0,0 @@ -language: ruby -dist: trusty -sudo: false -cache: bundler -addons: - apt: - packages: - - vim-gtk -branches: - only: - - master -before_script: - - vim --version -script: - - make test diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8e1fc2f..2c59e41 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -20,6 +20,14 @@ Running Tests - Run the tests with the command:: $ rspec spec +- Alternatively you can use Docker:: + + $ make test_docker + +- You can select tests based on line numbers, e.g.:: + + $ rspec ./spec/indent/indent_spec.rb:385 + $ make test_docker RSPEC_ARGS=./spec/indent/indent_spec.rb:385 Thank you for considering to contribute! diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ce08f9d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,19 @@ +FROM testbed/vim:latest + +RUN apk --no-cache add gtk+2.0-dev libx11-dev libxt-dev mcookie xauth xvfb +RUN install_vim -tag master --with-features=normal \ + --disable-channel --disable-netbeans --disable-xim \ + --enable-gui=gtk2 --with-x -build +RUN ln -s /vim-build/bin/vim-master /usr/bin/gvim +RUN gvim --version + +WORKDIR /vim-python-pep8-indent + +ADD Gemfile . +RUN apk --no-cache add coreutils ruby-bundler +RUN bundle install + +ADD indent ./indent +ADD spec ./spec + +ENTRYPOINT ["rspec", "spec"] diff --git a/Makefile b/Makefile index 5099a58..874c7ed 100644 --- a/Makefile +++ b/Makefile @@ -6,3 +6,23 @@ test_slow: test_visible: VIMRUNNER_REUSE_SERVER=1 bundle exec rspec + +# Run tests in dockerized Vims. +DOCKER_REPO:=blueyed/vim-python-pep8-indent-vims-for-test +DOCKER_TAG:=1 +DOCKER_IMAGE:=$(DOCKER_REPO):$(DOCKER_TAG) + +docker_image: + docker build -t $(DOCKER_REPO):$(DOCKER_TAG) . +docker_push: + docker push $(DOCKER_REPO):$(DOCKER_TAG) +docker_update_latest: + docker tag $(DOCKER_REPO):$(DOCKER_TAG) $(DOCKER_REPO):latest + docker push $(DOCKER_REPO):latest + +test_docker: XVFB_ERRORFILE:=/dev/null +test_docker: + @set -x; export DISPLAY=$(if $(VIMRUNNER_TEST_DISPLAY),$(VIMRUNNER_TEST_DISPLAY),172.17.0.1:99; Xvfb -ac -listen tcp :99 >$(XVFB_ERRORFILE) 2>&1 & XVFB_PID=$$!); \ + docker run --rm -ti -e DISPLAY -e VIMRUNNER_REUSE_SERVER=1 \ + -v $(CURDIR):/vim-python-pep8-indent $(DOCKER_IMAGE) $(RSPEC_ARGS) \ + $(if $(VIMRUNNER_TEST_DISPLAY),,; ret=$$?; kill $$XVFB_PID; exit $$ret) diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..71760c2 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,6 @@ +version: '2' +services: + rspec: + build: . + volumes: + - .:/vim-python-pep8-indent -- 2.39.2