cslabs-backend

Development

Git Workflow

The main branch is master, which will hold the version currently running in production. When some work needs to be done, you will branch off from master using the naming convention <initials>/<feature-name> for your branch. After the work has completed, the developer should create a PR in Github to merge the branch back into dev and notify the project lead to review. Please make sure to submit a PR to merge into dev branch and not master.

Tutorial

Follow these tutorials to get started.

.Net Core Web Api Tutorial

EF Core Documentation

Setup

• .NET Core Download the latest .net core 6 SDK

• Install entity framework tools dotnet tool install --global dotnet-ef

• The Official IDE is Rider. Visual Studio 2019 Can be used as a fallback (Rider is preferred) but you have to set the launch profile to CSLabsBackend

• Copy appsetting.Example.json to appsettings.json

• Replace Email section of appsettings.json with the testing MailTrap credentials in Email Credentials card in Trello

• Install MariaDB Choose no password when it asks you

• cd into CSLabs.Api and run dotnet ef database update

• Note: Every time changes are pulled from the repository, it is a good idea to perform this step again: cd into CSLabs.Api and run dotnet ef database update

Setup steps for connecting to a proxmox server

These steps are only required if you plan on starting a lab.

• Open terminal to the solution folder
• cslabs change-hypervisor-password --id 1 --password <proxmox root password> You can get the password from this Trello card. Note: If on linux you have to write ./cslabs instead.
• Connect to the VPN whenever you need to test with the proxmox server.

Managing Hypervisors

To connect to a proxmox host, you will need to add them to the DB. The passwords used to access the proxmox host is encrypted so a command is developed to ease the process of adding them.

1. Open the terminal to the solution folder.
2. Run cslabs help

This will show you all the commands available:

  add-hypervisor                Adds a hypervisor to the database

  add-hypervisor-node           Adds a hypervisor node to the database

  change-hypervisor-password    Changes the password for a hypervisor

  list-hypervisors              Lists hypervisors in the database

  encrypt                       Encrypts a string

  decrypt                       Decrypts a string

You will need to change the password of the default hypervisor. The password is found in trello in the notes column

cslabs change-hypervisor-password --id 1 --password <password given>

Documentation in trello

Note: On production and staging the novnc url has to be added manually to the nginx config if a new host is added.

MariaDB Setup

Setup MariaDB 10.2.13

Database Diagram

Download MYSQL Workbench from here

Open cslabs-db-diagram.mwb in the root of this project using mysql workbench.

Ef Core

Steps before Creating Migration

Before running any dotnet ef commands, cd into <solution-dir>/CSLabs.Api. Also before generating migration, go to Models/DefaultContext.cs and add the line below.

Important Note

The property name dictates the table names. We standardize on plural table names.

DbSet<YourModelName> YourTableName { get; set; }

Example: DbSet<User> Users { get; set; }

If your model needs extra configuration, by convention in this project, we add an OnModelCreating to the model's class to configure it (please look at the other models as an example). In order for it to take affect, you will need to call it in the OnModelCreating method in the DefaultContext.cs file.

protected override void OnModelCreating(ModelBuilder builder)
{
  base.OnModelCreating(builder);
  ... all the other models being called..
  YourModel.onModelCreating(builder);
}

To generate a migration based on your latest changes, type:

dotnet ef migrations add <MigrationName>

Steps to Update Migration

Modify the migration if it doesn't suite your needs exactly.

To Update the database with the migration using this command:

dotnet ef database update

Steps to Remove Migration

Sometimes you add a migration and realize you need to make additional changes to your EF Core model before applying it. To remove the last migration, use this command.

dotnet ef migrations remove

Read more about migrations here

To revert a migration:

dotnet ef database update LastGoodMigration

Steps to complete for a Migration when a Pull Request is Merged

If a pull request was merged into dev that contains a migration and your branch also added a migration, then you will need to perform the following steps:

Revert your migration by using the update command to the migration before yours

dotnet ef database update TheMigrationNameBeforeYours

Then remove your migration

Note: If you made any modifications to your migration after it was generated then you will need to copy those changes out in to a notepad in order to not lose them.

dotnet ef migrations remove

Then merge dev into your branch

Then re-add your migration

dotnet ef migrations add YourMigrationName

Then re-apply your migration

dotnet ef database update