This is a working application that can be used to demonstrate how to build, test, deploy and verify a complete CI/CD pipeline using Guide-Rails®
Buzzworthy-Demo-Python is simple web application using Python and Flask.
Credit: This application is shamelessly borrowed and adapted from Rob van der Leek's cicd-buzz.
Important:
- You do not need to know Python to follow this tutorial
- You will not need to setup a local Python environment if you don't want to - you can build, test, deploy and verify the demo application via the Guide-Rails® UI or editing configuration and pushing to your Git repository
There are a number of online guides for installing and/or upgrading Python on your system at https://www.python.org/. For this tutorial you need Python 2.7 or later
$ python --version
Python 2.7.10
$ pip install virtualenv
$ virtualenv venv
$ source venv/bin/activate
The tutorial application uses pytest for unit testing and flask web application framework. Required versions of these dependencies are in the requirements.txt file.
(venv) $ pip install -r requirements.txt
(venv) $ python -m pytest -v tests/test_generator.py
=========================================================== test session starts ============================================================
platform darwin -- Python 2.7.10, pytest-3.0.6, py-1.8.0, pluggy-0.4.0 -- /Users/foo/buzzworthy-demo-python/venv/bin/python
cachedir: .cache
rootdir: /Users/foo/buzzworthy-demo-python, inifile:
collected 3 items
tests/test_generator.py::test_sample_single_word PASSED
tests/test_generator.py::test_sample_multiple_words PASSED
tests/test_generator.py::test_generate_buzz_of_at_least_five_words PASSED
========================================================= 3 passed in 0.02 seconds =========================================================
(venv) $ python webapp.py
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
Setting up your pipeline in Guide-Rails® is easy. The following steps assume that you already have a Guide-Rails® account and have completed initial configuration of your subscription with required information for your Company, Organizations, Projects, etc. This tutorial also assumes that you will be using the Guide-Rails® Configuration Console for setting up your pipeline. Alternatively, you can define your pipeline by creating a configuration file and storing it in ci/guide-rails.json in the root directory of your application's source code repository.
The first step is to create a new Component in Guide-Rails which will be associated to your buzzworthy application.
From the top navigation bar of the Guide-Rails® Configuration Console, navigate to the Project where your new Component will live, then choose Create New from the Component menu:
Second, provide Guide-Rails® with a little information about the application (aka Component) you wish to onboard. In the Guide-Rails® Configuration Console, you will provide the following: