use docker for testing

Author: sp1thas

.github/workflows/python-testing.yml

@@ -1,29 +1,24 @@
 name: Shell Testing
 
 on:
-  push:
-    branches: [ master ]
-    paths:
-      - 'src/**.sh'
-      - 'tests/*.bats'
-      - '.github/workflows/shell-testing.yml'
   pull_request:
     branches: [ master ]
     paths:
-      - 'src/**.sh'
-      - 'tests/*.bats'
-      - '.github/workflows/shell-testing.yml'
-  workflow_run:
-    workflows:
-      - 'Shellcheck'
-    types:
-      - completed
+      - '**.sh'
+      - '**.bats'
+      - '.github/workflows/testing.yml'
 
 env:
   HOMEBREW_NO_AUTO_UPDATE: 1
 
 jobs:
+  checkout-code:
+    steps:
+      - uses: pre-commit/action@v3.0.0
+      - uses: pre-commit-ci/lite-action@v1.0.1
+        if: always()
   unit:
+    needs: [checkout-code]
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false

.github/workflows/shell-check.yml

@@ -2,15 +2,16 @@ ci:
     skip: [poetry-lock]
 
 repos:
+-   repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.9.0
+    hooks:
+    -   id: shellcheck
+        files: '\.(bats|sh)$'
 
--   repo: https://github.com/python-poetry/poetry
-    rev: '1.7.0'
+-   repo: https://github.com/iamthefij/docker-pre-commit
+    rev: v3.0.1
     hooks:
-    -   id: poetry-check
-        files: '^pyproject\.toml$'
-    -   id: poetry-lock
-        files: '^pyproject\.toml$'
-        args: [ '--no-update' ]
+    -   id: docker-compose-check
 
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
@@ -25,13 +26,3 @@ repos:
         args: [ --unsafe ]
     -   id: detect-private-key
     -   id: trailing-whitespace
-
--   repo: https://github.com/psf/black
-    rev: 23.11.0
-    hooks:
-    -   id: black
-
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.7.0'
-    hooks:
-    -   id: mypy

.github/workflows/shell-testing.yml renamed to .github/workflows/testing.yml

@@ -0,0 +1,31 @@
+FROM alpine:3.17
+
+ENV BATS_SUPPORT_VERSION='0.3.0'
+ENV BATS_ASSERT_VERSION='2.1.0'
+ENV BATS_FILE_VERSION='0.4.0'
+
+RUN apk add --no-cache \
+    attr \
+    bats \
+    coreutils \
+    diffutils \
+    grep \
+    make
+
+
+WORKDIR /opt
+
+RUN wget -q "https://github.com/bats-core/bats-support/archive/refs/tags/v${BATS_SUPPORT_VERSION}.zip" -O support.zip && \
+    unzip -q support.zip && \
+    mv bats-support-${BATS_SUPPORT_VERSION} bats-support && \
+    rm support.zip && \
+    wget -q "https://github.com/bats-core/bats-assert/archive/refs/tags/v${BATS_ASSERT_VERSION}.zip" -O assert.zip && \
+    unzip -q assert.zip && \
+    mv bats-assert-${BATS_ASSERT_VERSION} bats-assert && \
+    rm assert.zip && \
+    wget -q "https://github.com/bats-core/bats-file/archive/refs/tags/v${BATS_FILE_VERSION}.zip" -O file.zip && \
+    unzip -q file.zip && \
+    mv bats-file-${BATS_FILE_VERSION} bats-file && \
+    rm file.zip
+
+CMD bash -c 'bats tests'

.gitmodules

@@ -4,15 +4,9 @@ DESTLIBDIR=/usr/local/lib/dropboxignore
 
 # run shell tests
 # bats should be in PATH
-shell-tests :
-	git submodule update --init
-	bats tests
 
-# run python tests
-python-tests :
-	poetry run pytest --cov=src tests/
-
-test : shell-tests python-tests
+test :
+	docker-compose run dropboxignore-tests
 
 # install dropboxignore
 install :

.pre-commit-config.yaml

@@ -7,9 +7,6 @@
     <a href='https://dropboxignore.simakis.me/en/latest/?utm=gh'>
         <img src='https://github.com/sp1thas/dropboxignore/actions/workflows/docs-deployment.yml/badge.svg' alt='Documentation Status' />
     </a>
-    <a href='https://results.pre-commit.ci/latest/github/sp1thas/dropboxignore/master'>
-        <img src='https://results.pre-commit.ci/badge/github/sp1thas/dropboxignore/master.svg' alt='pre-commit.ci status' />
-    </a>
     <a href="https://codecov.io/gh/sp1thas/dropboxignore">
     <img src="https://codecov.io/gh/sp1thas/dropboxignore/branch/master/graph/badge.svg?token=LBVA80F2DV"/>
     </a>

Dockerfile

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  dropboxignore-tests:
+    build:
+      context: "."
+      dockerfile: "Dockerfile"
+    image: "alpine-dropboxignore:latest"
+    volumes:
+      - './src:/opt/src'
+      - './tests:/opt/tests'

Makefile

@@ -14,6 +14,7 @@ For something that is bigger than a one or two line fix:
     * Be sure you have followed the code style for the project.
     * Update documentation accordingly
     * Add test cases if is applicable.
+    * follow ![development](development.md) guidelines
 
 ## How to report a bug
 

README.md

@@ -0,0 +1,19 @@
+# Developemt Guidelines
+
+Here you will find details on how to set up a dev environment in order to develop a new feature or fix a bug.
+
+## Dev environment
+
+
+### Re-requisites
+
+ - Docker
+ - pre-commit
+
+## Setup
+
+After forking the repo, navigate in the project and:
+
+```shell
+pre-commit install
+```

docker-compose.yaml

@@ -1,16 +1,13 @@
 # Testing
 
-Tests of dropboxignore are written using [bats](https://github.com/bats-core/bats-core) and they live inside the
-`tests` folder. You can run them using the `Makefile`:
+Tests of dropboxignore are written using [bats,](https://github.com/bats-core/bats-core) and they live inside the
+`tests` folder. You can run them using the `Makefile` (docker and docker-compose should be installed):
 
 !!! info
-    Make sure that bats is installed in your system and also in you `PATH` (use your package manager
-[[1](https://formulae.brew.sh/formula/bats-core), [2](https://packages.debian.org/buster/bats),
-[3](https://archlinux.org/packages/community/any/bash-bats/) ] or install it from
-[source](https://github.com/bats-core/bats-core)).
+    Make sure that Docker and docker-compose are installed.
 
 ```shell
-$ make shell-tests
+$ make test
 ```
 
 If you are planning to implement a new feature, make sure that the necessary test cases have been added.

docs/contributing.md

@@ -33,6 +33,7 @@ nav:
   - 'Get started': 'getting-started.md'
   - 'CLI': 'cli.md'
   - 'Development':
+      - Development: 'development.md'
       - Contributing: 'contributing.md'
       - Testing: 'testing.md'
 

docs/development.md

@@ -7,6 +7,8 @@ SCRIPT_PATH="$(cd -- "$(dirname "$0")" >/dev/null 2>&1 && pwd -P )"
 
 if [ "$SCRIPT_PATH" == "/usr/local/bin" ]; then
   LIB_PATH="/usr/local/lib/dropboxignore"
+elif [ "$SCRIPT_PATH" == "/code" ]; then
+  LIB_PATH="/code/src/lib"
 else
   LIB_PATH="$SCRIPT_PATH/../lib"
 fi

docs/testing.md

@@ -8,7 +8,7 @@ setup() {
 @test "Test delete command" {
   mkdir "$BATS_TEST_TMPDIR/other"
   touch "$BATS_TEST_TMPDIR/other/$DROPBOXIGNORE_NAME"
-  run $dropboxignore delete "$BATS_TEST_TMPDIR"
+  run ${dropboxignore:?} delete "$BATS_TEST_TMPDIR"
   assert_success
   assert_file_not_exist "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   assert_file_not_exist "$BATS_TEST_TMPDIR/other/$DROPBOXIGNORE_NAME"

libs/bats-assert

@@ -1,29 +1,30 @@
 #!/usr/bin/env bash
 # shellcheck shell=bash
+# shellcheck disable=SC2034
 setup() {
     load 'test_helper/common-setup'
     _common_setup
 }
 
 @test "Test generate command when .dropboxignore file not exists" {
-  rm -rf "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
-  run $dropboxignore generate "$BATS_TEST_TMPDIR"
+  rm -rf "${BATS_TEST_TMPDIR:?}/$DROPBOXIGNORE_NAME"
+  run ${dropboxignore:?} generate "$BATS_TEST_TMPDIR"
   assert_success
   assert_file_exist "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   assert_output --partial "Created file: .dropboxignore"
   assert_output --partial "Total number of generated files: 1"
 }
 
 @test "Test generate command when .dropboxignore file exists" {
-  run $dropboxignore generate "$BATS_TEST_TMPDIR"
+  run ${dropboxignore:?} generate "$BATS_TEST_TMPDIR"
   assert_success
   assert_file_exist "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   assert_output --partial "Total number of generated files: 0"
 }
 
 @test "Test generate command when .gitignore file not exists" {
   rm "$BATS_TEST_TMPDIR/$GITIGNORE_NAME" "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
-  run $dropboxignore generate "$BATS_TEST_TMPDIR"
+  run ${dropboxignore:?} generate "$BATS_TEST_TMPDIR"
   assert_success
   assert_file_not_exist "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   assert_file_not_exist "$BATS_TEST_TMPDIR/$GITIGNORE_NAME"
@@ -34,7 +35,7 @@ setup() {
   rm "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   echo "a
   !something" > "$BATS_TEST_TMPDIR/$GITIGNORE_NAME"
-  run $dropboxignore generate "$BATS_TEST_TMPDIR"
+  run ${dropboxignore:?} generate "$BATS_TEST_TMPDIR"
   assert_success
   assert_file_not_exist "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   assert_output --partial ".gitignore contains exception patterns, will be ignored"

libs/bats-file

@@ -6,8 +6,8 @@ setup() {
 }
 
 @test "Test genupi command" {
-  rm -rf "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
-  run $dropboxignore genupi "$BATS_TEST_TMPDIR"
+  rm -rf "${BATS_TEST_TMPDIR:?}/$DROPBOXIGNORE_NAME"
+  run ${dropboxignore:?} genupi "$BATS_TEST_TMPDIR"
   assert_success
   assert_file_exist "$BATS_TEST_TMPDIR/$DROPBOXIGNORE_NAME"
   assert_file_exist "$BATS_TEST_TMPDIR/$GITIGNORE_NAME"