lab-github-actions

This is for NYU DevOps lab on using GitHub Actions with Redis for Continuous Integration

Introduction

This lab contains a workflow.yml file in the .github/workflows/ folder that shows you how to run your tests and start a Redis service be attached while running them. It also uses Code Coverage to determine how complete your testing is.

GitHub Actions can be used as an alternative to Travis CI to run tests on every Pull Request to facilitate implementing Continuous Integration for your development team. Every Pull Request is an opportunity for a code review and any Pull Request that lowers the test coverage should be rejected until more test cases are added to bring the coverage back up to the threshold set by the team. (usually 90% to 95%)

Setup

To complete this lab you will need to Fork this repo because you need to make a change in order to trigger GitHub Actions. When making a Pull Request, you want to make sure that your request is merging with your Fork because the Pull Request of a Fork will default to come back to this repo and not your Fork.

You can read about why in my article Creating Reproducible Development Environments.

Prerequisite Installation

All of our development is done in Docker containers using Visual Studio Code. This project contains a .devcontainer folder that will set up a Docker environment in VSCode for you. You will need the following:

Docker Desktop for Mac or Windows
Microsoft Visual Studio Code (VSCode)
Remote Containers VSCode Extension

It is a good idea to add VSCode to your path so that you can invoke it from the command line. To do this, open VSCode and type Shift+Command+P on Mac or Shift+Ctrl+P on Windows to open the command palete and then search for "shell" and select the option Shell Command: Install 'code' command in Path. This will install VSCode in your path.

Then you can start your development environment up with:

    git clone https://github.com/nyu-devops/lab-github-actions.git
    cd lab-github-actions
    code .

The first time it will build the Docker image but after that it will just create a container and place you inside of it in your /app folder which actually contains the repo shared from your computer. It will also install all of the VSCode extensions needed for Python development.

If it does not automatically prompt you to open the project in a container, you can select the green icon at the bottom left of your VSCode UI and select: Remote Containers: Reopen in Container.

Alternate manual install using local Python

This option is not recommended because developing natively on your local computer does ensure that the code will work on anyone elses computer or in production. I strongly recommend that you Docker with Visual Studio Code to create a reproducible development environment, but if you cannot for some reason, and have Python 3 installed on your computer, you can make a Python virtual environment and run the code locally with:

    python3 -m venv venv
    source venv/bin/activate
    pip install -r requirements.txt

You will also need Docker on your computer to run a container for the database.

docker run -d --name redis -p 6379:6379 -v redis:/data redis:alpine

This will run Redis on Alpine and have it forward port 6379 so that your application and communicate with it.

You can now run nosetests to run the TDD tests locally.

You can also test the application manually by running it with:

honcho start

Manually running the Tests

Run the tests using nosetests and coverage

nosetests

Nose is configured to automatically include the flags --with-spec --spec-color --with-coverage so that red-green-refactor is meaningful. If you are in a command shell that supports colors, passing tests will be green while failing tests will be red.

What's featured in the project?

    * routes.py -- the main Service using Python Flask and Redis
    * test_service.py -- test cases using unittest
    * .github/workflows/workflow.yml -- the GitHub Actions file that automates testing

License

Licensed under the Apache License. See LICENSE

This repository is part of the NYU masters class: CSCI-GA.2820-001 DevOps and Agile Methodologies conceived, created, and taught by John Rofrano Adjunct Instructor, NYU Courant Institute of Mathematical Sciences, Graduate Division, Computer Science, and NYU Stern School of Business.

AdamBrousseau/lab-github-actions