volleymanagement/volley-management

Volley Management API component. Provides API to create and manage Volleyball tournaments.

README

Welcome to Volley Management project repository

Status

Work Pulse

🚧 ⬇ Not actual. Will be fixed soon.

What is this repository for?

The goal of the project is to create system to manage Volleyball sport events for amateur leagues. Also it serves as a training ground to try different engineering and architectural approaches to learn in a safe environment. See more history here: Volley Management v3 - Διαχειριπη

Current Version: v3

How do I get set up?

Summary of set up

Project uses .NET Core and Angular at the moment. Recommended tools are VS 2019 (any edition) and VS Code. Although it should run using any other setup , I hope :)

Target framework is .NET Core 3.0.

Dependencies

All .NET dependencies are managed via NuGet. Angular uses NPM.

Development Environment Setup

Follow this Guide.

Deployment instructions

Prepare Azure Storage

In order to configure Azure Storage locally you need to run migrations to setup all required tables.

1. Prepare migration. Run following command:

   ./migrations/publish-azure-storage-migration.ps1

2. Run migration itself:

   cd ./migrations/azureStorageMigration

   dotnet VolleyM.Tools.MigrationTool.dll

Run Code

To run code locally it is recommended to use Docker to spin up local instance and test. This options is the closest to the production setting. You have few options there:

• Use VS Container Tools and run start project using Docker launch profile. VS injects few useful items like debugger so you'll be able to debug code running inside Docker.

• Build and run container manually. See /dev-env folder for some scripts.

If you want to shorten development cycle you can run application locally. Use VolleyM.API launch profile. It will execute dotnet run.

In production we use Azure DevOps Pipeline to build and deploy code.

How to run tests

Instructions.

Additional references

• License
• Contribution Guidelines
• Code of Conduct

Who do I talk to❓

• All questions should be directed to Sergii Diachenko (sdiachenko AT outlook DOT com)

volley-management's Issues

Upcoming round is displayed as "null:null" in Pivot standings

This is how json response look like for one of those cells:

Enable SonarLint

• make SonarLint pull setting from our sonar
• update wiki on how to configure SonarLint

Game stats

у нас кстати табло вместе со статистикой, но пока локально на компе и мы думаем сделать её на серваке и чтобы у каждой встречи была статистика которая будет на странице своей (как видео) и ссылка встречи как раз должна вести на эту страницу и потом на ней ссылка на видео

Fix AppVeyor UTs

https://ci.appveyor.com/project/sdiachen/volley-management/build/1.0.2/tests

AppVeyor not importing all tests

When we Import test result into AppVayor it loses couple of tests.

Console reports 529 tests passed, AppVeyor shows 507.

Investigate and fix :)

Investigate OWASP top 10 applicability

Analyze and protect against OWASP top 10 .NET

Analyze cheat sheet: https://www.owasp.org/index.php/.NET_Security_Cheat_Sheet Also following links: https://www.owasp.org/index.php/Exception_Handling, https://www.owasp.org/index.php/ASP.NET_Request_Validation, https://www.owasp.org/index.php/ASP.NET_Output_Encoding

Create investigation/coding task for all mentioned items.

Improve defect localization for Standings tests

Instead of one "Get(Pivot)Standings_GameResultsAllPossibleScores_CorrectStats" case we should have 4:

"Get(Pivot)Standings_GameResultsAllPossibleScores_CorrectPointStats"

"Get(Pivot)Standings_GameResultsAllPossibleScores_CorrectGamesStats"

"Get(Pivot)Standings_GameResultsAllPossibleScores_CorrectSetsStats"

"Get(Pivot)Standings_GameResultsAllPossibleScores_CorrectBallStats"

AC:

-[] Test should fail only if a specific part of calculation logic is broken. E.g. if we have defect in Games statistics calculation only this test should fail

• #181 Test for Correct Point

• #182 Test for Correct Games

• #183 Test for Correct Sets

• #184 Test for Correct Ball

• Delete tests "Get(Pivot)Standings_GameResultsAllPossibleScores_CorrectStats"

Integrate SonarQube

Show standings and pivot table grouped by divisions on the page

For volley.org.ua results page we want to show tables in following order:

1. standings 1 division

2. pivot 1 division

3. standings 2 division

4. pivot 2 division

Currently we show:

1. standings 1 division

2. standings 2 division

3. pivot 1 division

4. pivot 2 division

Schedule order over several years

When schedule spans over several years schedule days should be grouped by year, then by week, then by day and so on

Run Code Coverage as part of CI

1. Setup dotCover to run in UnitTests step of Cake
2. Provide Test Results to Sonar
3. Provide Coverage Reports to Sonar

Run CI only for master or "issue_#" brnaches

Adaptive layout for standings grids

TBD by Sergii Diachenko

Investigate DB queries perfromance

Display Division name for each standing table

LastUpdate time separated by divisions

Each division should have separate last time updated value

Import wiki from Bitbucket

Import wiki from bitbucket leaving only applicable info

Local Dev Secrets: ReCaptcha

Document process of obtaining ReCaptcha keys to make it work

Manage teams: show divsions and groups

On manage teams page teams should be grouped by divisions and groups

AC:

• User should see clear separation between teams playing in different divisions and groups

• #188 Group teams

• #190 Change UT

• #189 Test results

Update Links in License and Contributor guidelines

Make sure all information for Contributor is up to date and available:

• Contributors
• License
• Readme
• PR workflow

Planned game and game with results should occupy same size

Do not increment version for PR builds

Configure Sonar to run analisys for SPA

As we use MS Build right now it picks only parts which are added to .csproj files. We have to provide additional path to analyze from

Same position for equal teams

Business logic should calculate positions:

Positions are set according to standings If there are several teams equal by all metrics positions should be equal

Game result log

Add Sonar badges to the home page

Add Quality gate to the "Status" section:
https://github.com/QualInsight/qualinsight-plugins-sonarqube-badges/wiki/Quality-Gate-status-badges

Add new Section "SonarQube status"
with all default measures: https://github.com/QualInsight/qualinsight-plugins-sonarqube-badges/wiki/Measure-badges

Import issues from Bitbucket

Team links in VOU should direct to VOU team page

Team name in: Schedule Standings * Pivot standings

Should be displayed as link.

This link should point at the team page at VOU site

Create Separate user for Sonar analysis

At this moment there is no separate user so all sonar qube warnings are reported as sdiachenko. Need to create separate user: https://docs.sonarqube.org/display/PLUG/GitHub+Plugin

Free day should be last in day

On schedule page when there is a free day game it should be displayed last

Change project structure

Change repo file structure to closely match common templates:

root:

• src
  -- VolleyManagement.Backend
  -- volley.org.ua_integration
  -- VolleyManagement.Frontend
  -- *.sln file
• build (move contents of BuildFiles here)
• tests (Tests for the backend)
• <remove .nuget folder>

AC:

• make sure build scripts, tests, solution build and angular build are working
• update CI for proper Cake build path (edit appveyor.yaml)

Cache Cake dependencies on AppVeyor

Update following part of yaml file

`cache:

• packages -> **\packages.config`

Test issue for PR+Sonar integration

Remove GMail based mail service

Remove GMail mail service and all related data as it's not needed anymore

Sabtasks:

• #116 Find all connection to GMail service
• #118 Remove GMail services and all related date

In scope of one day games should be ordered by time with no regards to the division they are playing at

Add GitHub webhook for AppVeyor

https://www.appveyor.com/docs/notifications/#appveyoryml-configuration-2

Setup AppVeyor

Add Test Step to AppVeyor

Local Dev Secrets: Google OAuth

Document process of obtaining Google OAuth credentials in order to make VM authorization work

Create ITA contribution guidelines

Describe process and guidelines for ITA:

• branching strategy
• DOD
• Scrum workflow
• PR approach

Local Dev Secrets: Page

Create a page to guide and explain how to obtain secrets for local dev environment.

• It should guide dev on how to create AppSettingsSecrets file for own usage.

• Add a note about security risks involved with commiting secrets to the source control

• Note: mention that for Prod Mail service we use SendGrid account(but we won't provide guide on how to obtain it's data). For Local dev we use DebugMailService which displays emails in the console.

Related to #34

Activate tournament

As an admin I want to be able to activate previously archived tournament.

Only TournamentAdmin or Admin can activate tournament.

Subtasks:

• #233 Activate option at tournament detail

• #234 Alert message

• #235 Add ActionLink

• #237 Manual QA tests

• #245 Unit test

Implement Debug data generator

Change approach to generating debug data to be more maintainable

Technical defeat game should be indicated in Schedule view

If game has technical defeat it should be indicated with asterisk, e.g. "3:0*". Schedule view should correctly display those cases

Technical Defeat is not saved

1. Create/Edit game result
2. Set Technical defeat flag
3. Save

Show penalty summary

As an user I want to be able to see information about penalties under standings table

AC:

• I can see all penalties for specific division under standings table

• Each penalty should display teams who were playing, team which was penalized, amount and reason

• Penalties are ordered by the date

Technical defeat game should be indicated in Pivot standings

If game has technical defeat it should be indicated with asterisk, e.g. "3:0*". Pivot standings should correctly display those cases

Calculate standings according to amount points that team could have earned

As we might have odd number of teams in division during tournament different teams have different number of games played. This slightly affects standings as our current approach does not account number of played games.

Order teams by ScoreRating: ScoreRating=Points/(TotalGames*PointsPer3to0Win)

Style upcoming round in Pivot standings

Set background color for upcoming round in Pivot Standings table to be #73bdef

Create Code Review checklist

• create checklist to check PRs for:
  -- Generated SQL
  -- Test naming
  -- etc.
• integrate it in Code Review process: make sure it's always near code you are reviewing