Adding example application and pipeline (#1)

Author: dandruszak

.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+.pytest_cache
+*.py[cod]
+*.log
+db.sqlite3
+.env
+.venv
+venv/
+
+.idea/

.iceci.yaml

@@ -0,0 +1,75 @@
+globals:
+  onFailure:
+  #  This failure handler will be called failed of any step in the pipeline
+  # comment this out if you do not want to integrate pipeline with slack
+  - handlerName: slack-notify-error
+
+failureHandlers:
+- name: debug-env
+  image: busybox
+  script: |
+    echo "### PWD"
+    pwd
+    echo "### ENV"
+    env
+    echo "ls -la"
+    ls -la
+
+- name: slack-notify-error
+  image: iceci/utils
+  script: |
+    cat <<EOF > slacknotify.json
+    {
+      "text" : "Build $ICE_BUILD_NUMBER on branch $ICE_GIT_BRANCH_NAME failed on step $ICE_FAILED_STEP_NAME commited by $ICE_GIT_AUTHOR_NAME"
+    }
+    EOF
+    curl -X POST -H 'Content-type: application/json' --data "@slacknotify.json" $SLACK_WEBHOOK
+  environment:
+    SLACK_WEBHOOK: "{{ slack-webhook }}"
+
+# Service with postgres will run during whole pipeline
+services:
+- name: db
+  image: postgres:11
+  environment:
+    POSTGRES_DB: testdb
+    POSTGRES_PASSWORD: dbpass
+    POSTGRES_USER: dbuser
+
+
+steps:
+- name: run-tests
+  dockerRun:
+    image: python:3.7
+    script: |
+      pip install -r requirements.txt
+      pip install -r requirements-test.txt
+      flask initdb
+      pytest quotes_tests.py
+    environment:
+      QUOTES_DB_URI: "postgresql+psycopg2://dbuser:dbpass@db:5432/testdb"
+      FLASK_APP: quotes.py
+
+- name: build-docker-image
+  dockerBuild:
+    dockerSecret: dockerhub
+    registry: docker.io
+    # TODO: change user and image name to repository that you have access to
+    user: iceci
+    imageName: example-python-webapp
+    tag: latest
+
+# comment this step out if you do not want to integrate this pipeline with slack
+- name: slack-notify
+  dockerRun:
+    image: iceci/utils
+    script: |
+      cat <<EOF > slacknotify.json
+      {
+        "text" : "Build $ICE_BUILD_NUMBER on branch $ICE_GIT_BRANCH_NAME finished successfully!"
+      }
+      EOF
+      curl -X POST -H 'Content-type: application/json' --data "@slacknotify.json" $SLACK_WEBHOOK
+    environment:
+      SLACK_WEBHOOK: "{{ slack-webhook }}"
+

Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.7
+
+EXPOSE 8080
+WORKDIR /code/
+ENV PYTHONPATH /code/
+
+ADD requirements.txt .
+
+RUN pip install --no-cache-dir -r requirements.txt && \
+    pip install gunicorn gevent
+
+ADD quotes.py /code/quotes.py
+
+CMD ["gunicorn", "--worker-class", "gevent", "--access-logfile", "-", "--capture-output", "--enable-stdio-inheritance", "-b", "0.0.0.0:8080", "quotes:app"]

README.md

@@ -1 +1,18 @@
-# example-python-flask-api
+# IceCI Python example - Flask API 
+
+This repository is a small example to help you get started building **IceCI** pipelines for Python applications. 
+
+The application itself is a very simplified example of a web API with tests. It's not by any means a guideline on building Python applications - its only purpose is showcasing how to build IceCI pipelines for Python applications.
+
+This repository is a *GitHub template repository*, so please feel free to create new repositories based on it and mess around with the code and the pipeline config. Please also check the information below for a list of prerequisites needed to run the pipeline in IceCI.
+
+# Setting up IceCI
+
+
+To launch the pipeline in IceCI you have to create 2 secrets - both of which are explicitly referenced in the `.iceci.yaml` file. 
+
+* `dockerhub` - docker hub credentials with `docker.io` set as registry.
+
+* `slack-webhook` - a generic secret with hook for Slack notifications - it can be ignored by commenting out the `slack-notify` step as well as the `slack-notify-error` failure handler in the pipeline definition file. 
+
+You can also find some additional info in the comments of the `.iceci.yaml` file itself.

quotes.py

@@ -0,0 +1,45 @@
+import os
+
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+
+dburi = os.getenv('QUOTES_DB_URI')
+if not dburi:
+    raise Exception('QUOTES_DB_URI environment variable not set')
+
+app = Flask('fakeapp')
+app.config['SQLALCHEMY_DATABASE_URI'] = dburi
+app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+
+db = SQLAlchemy(app)
+
+
+class Quote(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    quote = db.Column(db.Text)
+    author = db.Column(db.String(60))
+
+    def __repr__(self):
+        return '<User %r - %r>' % (self.author, self.quote)
+
+
+@app.route('/')
+def hello_world():
+    return {'message': 'Hello, World!'}
+
+
+@app.route('/quote')
+def quote():
+    quotes = Quote.query.all()
+    res = []
+    for q in quotes:
+        res.append({
+            'author': q.author,
+            'quote': q.quote
+        })
+    return {'quotes': res}
+
+
+@app.cli.command("initdb")
+def initdb():
+    db.create_all()

quotes_tests.py

@@ -0,0 +1,28 @@
+import pytest
+import quotes
+
+
+@pytest.fixture()
+def app():
+    app = quotes.app
+    return app
+
+
+@pytest.fixture()
+def create_quote():
+    q = quotes.Quote(author='Guido van Rossum',
+                     quote="Python is an experiment in how much freedom programmers need. Too much freedom and nobody can read another's code; too little and expressiveness is endangered.")
+    quotes.db.session.add(q)
+    quotes.db.session.commit()
+
+
+def test_index(client):
+    assert client.get('/').status_code == 200
+
+
+@pytest.mark.usefixtures('create_quote')
+def test_quote(client):
+    result = client.get('/quote')
+    assert result.status_code == 200
+    data = result.json
+    assert len(data['quotes']) == 1

requirements-test.txt

@@ -0,0 +1 @@
+pytest-flask

requirements.txt

@@ -0,0 +1,3 @@
+flask
+flask-sqlalchemy
+psycopg2-binary