/task-runner

This is a backend engineer interview project

Primary LanguagePythonMIT LicenseMIT

Task Runner

CI Workflow

This is an interview project for the position of a backend engineer.

Background

Implement a background task that will read the tasks from mongo db and execute it and then save the output to db

  • Python flask server should run in a docker container.

Tech-stack

  • Tech-stack

    • Docker - a tool designed to make it easier to create, deploy, and run applications by using containers.
    • Python 3 - an interpreted high-level general-purpose programming language
    • Flask - a micro web framework written in python.
      • MongoDB - a cross platform document-oriented(NoSQL) database program
      • Redis - an in-memory data structure store used as a message broker.
      • Celery - an asynchronous task queue based on distributed message passing.

  • Tests

    • pytest - a testing framework for python

###Install

# clone the repository
$ git clone https://github.com/dennismwagiru/task-runner
$ cd task-runner

###Build and run image

$ docker-compose up --build -d

Run in Postman

###Test

$ docker-compose run --rm api sh -c "pytest && flake8"

###Test Coverage

$ docker-compose run --rm api sh -c "pytest --cov-report term --cov=src/app src/tests/"

More tests can be added

License

MIT License

Copyright (c) 2021 Dennis Joel Mwagiru

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.