Borzoo

A Zevere GraphQL Web API implementation in ASP.NET Core C#.

Getting Started

Make sure you have .NET Core SDK 2.0 installed on your system.

First, clone this repository and run the web app:

# Clone the repository
git clone https://github.com/Zevere/WebAPI-Borzoo.git

# Switch to the WebAPI-Borzoo directory
cd WebAPI-Borzoo

# Clone dependency projects
git submodule update --init --recursive

# Run the web project from CLI or an IDE
dotnet run ./src/Borzoo.Web/Borzoo.Web.csproj

After running the web app, hit http://localhost:5000/zv/GraphiQL and execute a GraphQL query like:

{
  user(userId: "bobby") {
    firstName
    lastName
    joinedAt
    lists { id }
  }
}

Application uses SQLite database by default so it is a painless start. You can change storage type to Mongo Db by modifying appsettings.

Development

• Repository pattern for data storage
  • SQLite implementation
  • Mongo Db implementation
• GraphQL API
• ASP.NET Core Web API to expose GraphQL
• Test Driven Development

Deployment

CI/CD pipeline is set with the help of AppVeyor, Travis-CI, and Docker.

Continuous Integration

AppVeyor

All commits are built on AppVeyor. It indicates there are no compile errors. See appveyor file.

Travis-CI

All commits are built and then tested on Travis-CI. This happens inside a Docker container on Travis-CI servers. See travis file.

Pull Requests are not built on Travis-CI due to potential risks of exposing environment variables configured on Travis-CI.

All the scripts for build, test, and deploy are written in JavaScript and require NodeJS to run.

ShellJS scripts are good to run on any operating system that is supported by NodeJS. This means we no longer need to be worry about whether we deploy to a Unix-like or a Windows machine.

Continuous Delivery

Deployment only happens if commit is pushed on master branch. If all the tests pass(process exits with return code of 0), deployment process begins. Application environment is set to Staging.

Staging Server

Deployment server needs to be accessible from Travis-CI container and have a Docker daemon. See Ubuntu Server Setup for more info.

Deployment Settings

As mentioned in travis file, some environment variables should be set to connect to deployment server from Travis-CI build container. Use gen-docker-certs.js script to create a JSON-serialized values for them.

# in /path/to/docker-certs directory
node /path/to/WebAPI-Borzoo/scripts/deploy/travis-ci/gen-docker-certs.js

This script assumes all Docker daemon certificate files are in one directory. Refer to Ubuntu server setup file.

Docker Compose

Docker Compose deploys multiple containers at the same time. (See docker-compose.yml)

• Web app (borzoo.web)
• Nginx web server

Nginx Configurations

Nginx acts as a reverse proxy here. Nginx container loads the configurations file on the host at /var/nginx/nginx.conf. See the sample nginx.conf.

There are different kinds of tests such as:

• MongoDB Integration Tests
• Web API Unit Tests
• Web API Systems Integration Tests

Testing framework in use is mainly xUnit.

Some tests such as systems integration tests take advantage of Docker-in-Docker approach where a temporary Mongo container runs in background to store data.