Set up Entity Framework as an ORM.

* If no DefaultConnection-ConnectionString is defined, will use InMemory-database instead
* Remove unused imports
* Create initial migrations

Issue #1

.config/dotnet-tools.json

@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "dotnet-ef": {
+      "version": "5.0.3",
+      "commands": [
+        "dotnet-ef"
+      ]
+    }
+  }
+}

.gitignore

@@ -3,9 +3,12 @@
 **/.idea/*
 **/.vscode/*
 
-# Ignore secrets
+# Ignore DB secrets
 **/secrets
 
+# Ignore local configuration files
+*.local.json
+
 
 # Created by https://www.toptal.com/developers/gitignore/api/csharp
 # Edit at https://www.toptal.com/developers/gitignore?templates=csharp

Controllers/BadgeController.cs

@@ -11,9 +11,9 @@ namespace SpeiderappAPI.Controllers
     [ApiController]
     public class BadgeController : ControllerBase
     {
-        private readonly BadgeContext _context;
+        private readonly DBContext _context;
 
-        public BadgeController(BadgeContext context)
+        public BadgeController(DBContext context)
         {
             _context = context;
         }

Migrations/20210308210034_InitialCreate.cs

@@ -0,0 +1,38 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
+
+namespace SpeiderappAPI.Migrations
+{
+    public partial class InitialCreate : Migration
+    {
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.CreateTable(
+                name: "BadgeList",
+                columns: table => new
+                {
+                    Id = table.Column<long>(type: "bigint", nullable: false)
+                        .Annotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn),
+                    Name = table.Column<string>(type: "text", nullable: false),
+                    Image = table.Column<string>(type: "text", nullable: false),
+                    Type = table.Column<string>(type: "text", nullable: false),
+                    Description = table.Column<string>(type: "text", nullable: false),
+                    Author = table.Column<string>(type: "text", nullable: false),
+                    RootNode = table.Column<int>(type: "integer", nullable: false),
+                    CreatedAt = table.Column<string>(type: "text", nullable: false),
+                    IsComplete = table.Column<bool>(type: "boolean", nullable: false),
+                    Secret = table.Column<string>(type: "text", nullable: false)
+                },
+                constraints: table =>
+                {
+                    table.PrimaryKey("PK_BadgeList", x => x.Id);
+                });
+        }
+
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropTable(
+                name: "BadgeList");
+        }
+    }
+}

Migrations/BadgeContextModelSnapshot.cs

@@ -0,0 +1,69 @@
+// <auto-generated />
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
+using SpeiderappAPI.Models;
+
+namespace SpeiderappAPI.Migrations
+{
+    [DbContext(typeof(DBContext))]
+    partial class BadgeContextModelSnapshot : ModelSnapshot
+    {
+        protected override void BuildModel(ModelBuilder modelBuilder)
+        {
+#pragma warning disable 612, 618
+            modelBuilder
+                .HasAnnotation("Relational:MaxIdentifierLength", 63)
+                .HasAnnotation("ProductVersion", "5.0.3")
+                .HasAnnotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn);
+
+            modelBuilder.Entity("SpeiderappAPI.Models.Badge", b =>
+                {
+                    b.Property<long>("Id")
+                        .ValueGeneratedOnAdd()
+                        .HasColumnType("bigint")
+                        .HasAnnotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn);
+
+                    b.Property<string>("Author")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.Property<string>("CreatedAt")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.Property<string>("Description")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.Property<string>("Image")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.Property<bool>("IsComplete")
+                        .HasColumnType("boolean");
+
+                    b.Property<string>("Name")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.Property<int>("RootNode")
+                        .HasColumnType("integer");
+
+                    b.Property<string>("Secret")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.Property<string>("Type")
+                        .IsRequired()
+                        .HasColumnType("text");
+
+                    b.HasKey("Id");
+
+                    b.ToTable("BadgeList");
+                });
+#pragma warning restore 612, 618
+        }
+    }
+}

Models/DBContext.cs

@@ -0,0 +1,14 @@
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
+
+namespace SpeiderappAPI.Models
+{
+    public class DBContext : DbContext
+    {
+        public DbSet<Badge> BadgeList => Set<Badge>();
+        private IConfiguration Configuration { get; }
+
+        public DBContext(DbContextOptions options, IConfiguration configuration) : base(options)
+            => Configuration = configuration;
+    }
+}

Program.cs

@@ -1,11 +1,5 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Hosting;
-using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Hosting;
-using Microsoft.Extensions.Logging;
 
 namespace SpeiderappAPI
 {
@@ -17,6 +11,7 @@ public static void Main(string[] args)
         }
 
         public static IHostBuilder CreateHostBuilder(string[] args) =>
+
             Host.CreateDefaultBuilder(args)
                 .ConfigureWebHostDefaults(webBuilder =>
                 {

README.md

@@ -27,6 +27,21 @@ dotnet watch run
 | DELETE      | /api/Badge/\<id\> | Delete a Badge     |
 
 
+## Local configuration
+
+### Development
+To override configuration settings which do not need to be secure locally,
+create
+```appsettings.Development.local.json```.
+To override/set development secrets,
+use:
+```bash
+dotnet user-secrets set <key> <value>
+```
+
+### Production
+Create ```appsettings.Production.local.json```, and
+
 # Guidelines & conventions
 
 ## Branches

SpeiderappAPI.csproj

@@ -3,16 +3,18 @@
   <PropertyGroup>
     <TargetFramework>net5.0</TargetFramework>
     <Nullable>enable</Nullable>
+    <UserSecretsId>6d78ab2e-1560-4d82-a173-5c28bf728190</UserSecretsId>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="5.0.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="5.0.1" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="5.0.3" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="5.0.1" />
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="5.0.1" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="5.0.2" />
+    <PackageReference Include="System.Configuration.ConfigurationManager" Version="5.0.0" />
   </ItemGroup>
 </Project>

Startup.cs

@@ -10,18 +10,33 @@ namespace SpeiderappAPI
 {
     public class Startup
     {
-        public Startup(IConfiguration configuration)
+        public IConfigurationRoot Configuration { get; }
+
+        public Startup(IWebHostEnvironment env)
         {
-            Configuration = configuration;
+            var builder = new ConfigurationBuilder()
+                .SetBasePath(env.ContentRootPath)
+                .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true) //load base settings
+                .AddJsonFile("appsettings.local.json", optional: true, reloadOnChange: true) //load local settings
+                .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true) //load environment settings
+                .AddJsonFile($"appsettings.{env.EnvironmentName}.local.json", optional: true) //load local environment settings
+                .AddEnvironmentVariables();
+
+            Configuration = builder.Build();
         }
 
-        public IConfiguration Configuration { get; }
-
         // This method gets called by the runtime. Use this method to add services to the container.
         public void ConfigureServices(IServiceCollection services)
         {
-            services.AddDbContext<BadgeContext>(opt =>
-               opt.UseInMemoryDatabase("BadgeList"));
+            services.AddDbContext<DBContext>(opt =>
+            {
+                var connectionString = Configuration.GetConnectionString("DefaultConnection");
+                if (connectionString is null)
+                    opt.UseInMemoryDatabase(
+                        Configuration.GetValue<string>("DefaultInMemoryDatabaseName"));
+                else
+                    opt.UseNpgsql(connectionString);
+            });
             services.AddControllers();
         }
 

appsettings.Development.json

@@ -5,8 +5,5 @@
       "Microsoft": "Warning",
       "Microsoft.Hosting.Lifetime": "Information"
     }
-  },
-  "ConnectionStrings": {
-    "DefaultConnection": "server=bifrost.local;port=3306;database=speiderapp;user=root;password=oh1CInd2YDOKPyw1z05Y"
   }
 }

appsettings.Development.local.json.example

@@ -0,0 +1,5 @@
+{
+  "ConnectionStrings": {
+    "DefaultConnection": "host=SERVER_NAME_HERE;port=PORT_NUMBER;database=DATABASE_NAME;username=USERNAME_HERE;password=PASSWORD_HERE"
+  }
+}

appsettings.json

@@ -6,5 +6,6 @@
       "Microsoft.Hosting.Lifetime": "Information"
     }
   },
-  "AllowedHosts": "*"
+  "AllowedHosts": "*",
+  "DefaultInMemoryDatabaseName": "speiderapp"
 }