QA-Core-Fundamental-Project

The fundamental skills project during DevOps training at QA

Table of contents

• Objective
• Requirements
  • Options
  • Technology
• Planning
  • UML
• Front-End
  • Create and read
  • Update
  • Delete
• Documentation
  • Risk Assessment
  • Testing
    • CI Server
    • Unit testing
    • Integration testing
• Issues

Objective

To create a CRUD application with utilisation of supporting tools, methodologies and technologies that encapsulate all core modules covered during training.

This project aims to complete the objective as a ttrpg dice application.

Requirements

• Kanban board (Trello)
  • User stories/Use cases/tasks
  • Record of issues or risks
• Relational database (Persistant)
  • At least 2 tables
  • Model a relationship
• Clear documentation
  • Describing architecture
  • Risk assessment
• Functional CRUD application
  • (Create, Read, Update, Delete) functionality
  • Follow best practices and design principles
  • Requirements of Kanban board met
• Test suite designed
  • Automated testing for validation of application
  • High test coverage in the backend
  • Consistent reports and evidence to support TDD (Test Driven Development)
• Front end (Flask)
  • Functioning website front-end
  • Integrated API's
• Version Control System
  • Feature-Branch model followed
  • Code built through a CI server
  • Deployed on a cloud-based Virtual Machine

Options

• Registration and Login Functionality

Technology

• Kanban Board
• Database: GCP SQL Server
• Programming language: Python
• Unit testing with Python: Pytest
• Integration testing with Python: Selenium
• Front-end: Flask (HTML)
• Version control: Git
• CI Server: Jenkins
• Cloud server: GCP Compute Engine

Planning

To view the full Trello board for this project Click here

UML diagrams for database

The original ERD for this project is presented below:

After more thought on the MVP and a better understanding of database design, the ERD was revised to the following:

Front-end

The user is greeted with an option to log in or register. CSS was used to highlight individual letter upon hover.

Username, email and password are mandatory fields, first name and last name are optional. The password is saved to the database using bcrypt.

A login page works and checks the bcrypt hash before logging in.

Create and read

The dashboard allows you to create entries in the database and read them to the page.

Update

The entries can be updated via the update page from the update button on the dashboard.

Delete

A bug was found in the delete functionality where the delete button did not work when the history table had entries in it. A hot-fix was created to delete the history table when an individual dice is deleted.

Documentation

Risk Assessment

Truncated risk assessment:

For a full view of the risk assessment: Click Here

Testing

CI Server Build environment Artifacts

An automated Continuous integration (CI) server was set up using Jenkins and build automation was set up using a webhook that triggered in response to git push on the dev branch of the github repo.

Unit testing

A coverage test artifact was generated in the post build step of the build.

The coverage of unit testing the application.

Integration testing

Buttons attached to forms failed to be accessible to the selenium tests repeatedly, therefore log in funcitonality could not be tested via selenium.

Issues

The main issue with the app is a lack of multi-user functionality. A goal for the future is creating a history table that can be accessed and edited by multiple users.

Integration testing using selenium repeatedly did not work.

When dice has been rolled, the delete function causes errors.