Merge pull request #22 from JWCook/integration-tests

Set up integration tests to run both locally and in GitHub Actions

.github/workflows/build.yml

@@ -20,6 +20,9 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
+      - uses: supercharge/mongodb-github-action@1.3.0
+        with:
+          mongodb-version: 4.4
 
       # Cache packages per python version, and reuse until setup.py changes
       - name: Cache pip packages
@@ -29,11 +32,12 @@ jobs:
           key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}
           restore-keys: ${{ runner.os }}-pip-${{ matrix.python-version }}
 
-      # TODO: tests
       - name: Install dependencies
         run: pip install ".[dev]"
       - name: Run unit tests
-        run: pytest
+        run: pytest test/unit
+      - name: Run integration tests
+        run: pytest test/integration
 
   analyze:
     runs-on: ubuntu-18.04

.gitignore

@@ -1,8 +1,10 @@
 *.py[cod]
-*.idea
 *.sqlite
 *.egg
 *.egg-info
+.idea/
+.vim/
+.vscode/
 build/
 dist/
 venv/

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+## Installation
+To set up for local development:
+
+```bash
+$ git clone https://github.com/JWCook/aiohttp-client-cache
+$ cd aiohttp-client-cache
+$ pip install -Ue ".[dev]"
+```
+
+## Pre-commit hooks
+[Pre-commit](https://github.com/pre-commit/pre-commit) config is uncluded to run the same checks
+locally that are run in CI jobs by GitHub Actions. This is optional but recommended.
+```bash
+$ pre-commit install --config .github/pre-commit.yml
+```
+
+To uninstall:
+```bash
+$ pre-commit uninstall
+```
+
+## Integration Tests
+Local databases are required to run integration tests, and docker-compose config is included to make
+this easier. First, [install docker](https://docs.docker.com/get-docker/) and
+[install docker-compose](https://docs.docker.com/compose/install/).
+
+Then, run:
+```bash
+$ docker-compose up -d
+pytest test/integration
+```
+
+## Documentation
+[Sphinx](http://www.sphinx-doc.org/en/master/) is used to generate documentation.
+
+To build the docs locally:
+```bash
+$ make -C docs html
+```
+
+To preview:
+```bash
+# MacOS:
+$ open docs/_build/index.html
+# Linux:
+$ xdg-open docs/_build/index.html
+```
+
+Documentation is automatically built by ReadTheDocs whenever code is merged into the `main` branch.
+
+
+## Releases
+Releases are built and published to pypi based on **git tags.**
+[Milestones](https://github.com/JWCook/aiohttp-client-cache/milestones) will be used to track
+progress on major and minor releases.
+

HISTORY.md

@@ -1,5 +1,9 @@
 # History
 
+## 0.2.0 (TBD)
+* Update SQLite backend to use `aiosqlite` for async cache operations
+* Update MongoDB backend to use `motor` for async cache operations
+
 ## 0.1.0 (2020-11-14)
 * Initial PyPI release
 * First pass at a general refactor and conversion from `requests` to `aiohttp`

README.md

@@ -39,15 +39,8 @@ To install with extra dependencies for all supported backends:
 pip install aiohttp-client-cache[backends]
 ```
 
-To set up for local development:
-
-```bash
-$ git clone https://github.com/JWCook/aiohttp-client-cache
-$ cd aiohttp-client-cache
-$ pip install -Ue ".[dev]"
-$ # Optional but recommended:
-$ pre-commit install --config .github/pre-commit.yml
-```
+See [Contributing](https://github.com/JWCook/aiohttp-client-cache/blob/main/README.md)
+for setup info for local development.
 
 ## Usage example
 See the [examples](https://github.com/JWCook/aiohttp-client-cache/blob/master/examples)

docker-compose.yml

@@ -0,0 +1,41 @@
+# Containers needed to test all backend services locally
+version: '3'
+
+services:
+  dynamodb:
+    image: amazon/dynamodb-local
+    hostname: dynamodb-local
+    container_name: dynamodb-local
+    ports:
+      - 8000:8000
+    command: "-jar DynamoDBLocal.jar -sharedDb -optimizeDbBeforeStartup -dbPath ./data"
+    volumes:
+      - 'dynamodb_data:/home/dynamodblocal/data'
+    working_dir: /home/dynamodblocal
+
+  mongo:
+    image: mongo
+    environment:
+      MONGO_INITDB_DATABASE: aiohttp_client_cache_pytest
+    ports:
+      - 27017:27017
+    volumes:
+      - 'mongodb_data:/data/db'
+
+  redis:
+    image: docker.io/bitnami/redis
+    environment:
+      ALLOW_EMPTY_PASSWORD: 'yes'
+      # REDIS_DISABLE_COMMANDS: 'FLUSHDB,FLUSHALL'
+    ports:
+      - 6379:6379
+    volumes:
+      - 'redis_data:/bitnami/redis/data'
+
+volumes:
+  dynamodb_data:
+    driver: local
+  mongodb_data:
+    driver: local
+  redis_data:
+    driver: local

docs/contributing.rst

@@ -0,0 +1,2 @@
+.. mdinclude:: ../CONTRIBUTING.md
+

docs/index.rst

@@ -16,6 +16,7 @@ Contents
 
    reference
    history
+   contributing
 
 
 Indices and tables

setup.py

@@ -19,6 +19,7 @@
     ],
     # Packages used for testing both locally and in CI jobs
     'test': [
+        'asyncmock; python_version=="3.7"',
         'black==20.8b1',
         'flake8',
         'isort',