arc-arnob / activity-gen

GameBoi - SDLC Activity Based Learning

Build	Code Quality	Unit Testing	Git Inspector

Folder Structure

Folder	Description
1_Requirements	Documents detailing requirements and research
2_Design	Documents specifying design details
3_Implementation	All code and documentation
4_Test_plan	Documents with test plans and procedures

---

Contributors List and Summary

PS Id.	Name	Features	Issues Raised	Issues Resolved	No Test Cases	Test Case Pass
99004349	Arnob Chowdhury	Snake GUI, Main Menu, Git Workflow, Code coverage, Code refactor- Tic Tac Toe, Connect Four, input validation, pylint	21	16	27	27
99004351	Debashish Dash	Sudoku solver, breaking files intomodules, Main menu, Coloring and clear-screen feature in main.py and sudoku.py, Banner and cover page of the project, Pylint and Docstring for tetris and Sudoku module	9	8	7	7
99004350	Durgapu Venkata Shyam Sudheer	Tetris GUI,Documentaion,Report	2	5	0	0
99004352	Anshul Mehta	Tictactoe game, Report making, defining user requirements	0	3	12	12
99004353	Anmol Tandon	Connect four GUI, Unit Testing, Report Building, State of Art and assigned work	3	5	6	6

Note: some test cases where user inuts are required are tested manually, those are not mentiones here, those test cases are written in the 4_TestPlans folder. Manually tested test cases: L_18, L19, H_09, H_10

Contribution Check

PS Id.	Name	Commits
99004349	Arnob	105
99004350	sudheer	50
99004351	Debashish	102
99004352	Anshul	34
99004353	Anmol	54

Feature List

Feature Id	Feature	Status
F_01	Snake game GUI	IMPLEMENTED
F_02	Tic Tac Toe Game GUI	IMPLEMENTED
F_03	Connect Four game GUI	IMPLEMENTED
F_04	Tetris Game GUI	IMPLEMENTED
F_05	Sudoku problems solver CLI	IMPLEMENTED
F_06	High Score registry	FUTURE
F_07	High Score gets stored to persistence layer after every game	FUTURE
F_08	High Score is updated after every game	FUTURE

Challenges Faced and How Was It Overcome

No.	Challenge	Solution
1.	Git Workflows	Manual Execution and reporting

Run on your PC

What Will You Build

You will build and run a gaming console which will allow you to play CLI and GUI based game.

What you will need

• A favorite text editor or IDE
• Python 3.7+ Interpretor
• Clone of this repository

To clone and run the project follow the below steps:

• Download and unzip the source repository for this guide, or clone it using Git: git clone https://github.com/GENESIS2021Q1/sdlc-team-31.git
• cd to 3_Implementation
• run pip install -r requirement.txt
• open main.py file and execute the file

To run Unit test cases follow the below steps

• Navigate to 3_Implementation
• on command line execute pytest -v test.py. Set -s flag to see more details
• to view detailed unit test report please follow the link: Unit Test Report

To run code coverage follow the below steps

• Navigate to 3_Implementation
• in command line execute pytest --cov=. --cov-report term test.py
• to view % coverage please follow the link: Code Coverage Report

To perform Linting follow steps below

• cd to /<package_name>
• run pylint <file_name>.py

To view Pylint reports follow table below:

File Name	Report
main.py	Main Menu Report
sudoku.py	Sudoku Feature Report
snake.py	Snake GUI Feature Report
c4.py	connect four GUI Feature Report
tictactoe.py	Tic Tac Toe Feature Report
tetris.py	Tetris Feature Report

References

• Pytest Youtube video
• Git credentials settings youtube video
• PyGame
• python modules