Added ability to edit benchmark parameters

Adding license to project

Co-authored-by: Gregory Ballantine <gballantine@bitgoblin.tech>
Reviewed-on: #10

.gitignore

@@ -3,6 +3,7 @@ blt
 
 # Local data files
 data/
+tmp/
 
 # Compiled assets
 public/css/

.woodpecker.yml

@@ -1,4 +1,4 @@
-pipeline:
+steps:
   build:
     image: golang:1.22
     commands:

README.md

@@ -0,0 +1,54 @@
+# Benchmark Logging Tool (BLT)
+
+![Build badge](https://builds.metaunix.net/api/badges/87/status.svg)
+
+Web-based tool to store and organize PC hardware benchmarks.
+
+## Project Goals
+
+The goals of this project are to:
+
+* Record benchmarking results from multiple devices - e.g. log from a laptop or a phone.
+* Group results into tests to keep track of different testing configurations.
+* Encourage running tests multiple times - it's good practice to run a benchmark multiple times for accuracy.
+* Create comparisons of hardware tests to compare performance.
+* Generate graphs of hardware comparisons for usage in videos and articles.
+
+## Requirements
+
+BLT runs on Go. It uses the built-in `go mod` tool to manage dependencies, thus there is no external tooling to install to build/run BLT.
+
+Debian/Ubuntu: `apt install -y golang`
+RedHat and clones: `dnf install -y golang`
+
+## Production Deployment
+
+**TODO**
+
+## Development
+
+### Via Docker
+
+**TODO**
+
+### Local/Native Development
+
+BLT uses [fresh](https://github.com/gravityblast/fresh) to auto-reload the app. While this is not strictly necessary, it used to make development more convenient. If you wish to forego installing it, you may simply build and run the app with the standard `go run main.go`.
+
+1. Install dependencies:
+
+`go mod download`
+
+2. Install fresh to auto-reload the app:
+
+`go install github.com/gravityblast/fresh@latest`
+
+3. Run the app via air:
+
+`fresh`
+
+4. If everything is running successfully you can open your browser and go to http://localhost:2830.
+
+## License
+
+This project is available under the BSD 2-Clause license.

models/benchmark.go

@@ -1,6 +1,8 @@
 package models
 
 import (
+  "strconv"
+
   "gorm.io/gorm"
 )
 
@@ -16,3 +18,7 @@ type Benchmark struct {
   // has many results
   Results     []Result
 }
+
+func (b *Benchmark) StringID() string {
+  return strconv.Itoa(int(b.ID))
+}

models/test.go

@@ -1,6 +1,8 @@
 package models
 
 import (
+  "strconv"
+
   "gorm.io/gorm"
 )
 
@@ -19,3 +21,24 @@ type Test struct {
   // has many results
   Results       []Result
 }
+
+func (t *Test) SelectedBenchmarks() []string {
+  benchmarks := t.Benchmarks
+  ids := make([]string, len(benchmarks))
+  for i, b := range benchmarks {
+    ids[i] = strconv.Itoa(int(b.ID))
+  }
+  return ids
+}
+
+func (t *Test) IsBenchmarkSelected(benchmarkID uint) bool {
+  benchmarkUint := uint(benchmarkID)
+
+  for _, b := range t.Benchmarks {
+    if b.ID == benchmarkUint {
+      return true
+    }
+  }
+
+  return false
+}

runner.conf

@@ -0,0 +1,14 @@
+root:              .
+tmp_path:          ./tmp
+build_name:        runner-build
+build_log:         runner-build-errors.log
+valid_ext:         .go, .tpl, .tmpl, .html
+no_rebuild_ext:    .tpl, .tmpl, .html
+ignored:           assets, tmp, node_modules, data, vendor
+build_delay:       600
+colors:            1
+log_color_main:    cyan
+log_color_build:   yellow
+log_color_runner:  green
+log_color_watcher: magenta
+log_color_app:

templates/benchmark/edit.tmpl

@@ -0,0 +1,38 @@
+{{ template "header" . }}
+
+<div class="row">
+  <h2>Editing Benchmark: {{ .benchmark.Name }}</h2>
+
+  <form class="twelve columns" action="/benchmark/{{ .benchmark.ID }}/edit" method="POST">
+    <div class="row">
+      <div class="nine columns">
+        <label for="benchmark_name">
+          Benchmark name:
+          <input id="benchmark_name" class="u-full-width" type="text" name="benchmark_name" placeholder="Unigine Heaven" value="{{ .benchmark.Name }}">
+        </label>
+      </div>
+
+      <div class="three columns">
+        <label for="benchmark_scoring">
+          Benchmark type:
+          <select id="benchmark_scoring" class="u-full-width" name="benchmark_scoring">
+            <option value="fps" {{ if eq .benchmark.ScoringType "fps" }}selected{{ end }}>Frames per second</option>
+            <option value="ms" {{ if eq .benchmark.ScoringType "ms" }}selected{{ end }}>Frame time</option>
+            <option value="pts" {{ if eq .benchmark.ScoringType "pts" }}selected{{ end }}>Total points</option>
+          </select>
+        </label>
+      </div>
+    </div>
+
+    <div class="row">
+      <label for="benchmark_description">
+        Benchmark description:
+        <textarea id="benchmark_description" class="twelve columns" cols="30" rows="10" name="benchmark_description">{{ .benchmark.Description }}</textarea>
+      </label>
+    </div>
+
+    <input class="button-primary u-full-width" type="submit" value="Submit">
+  </form>
+</div>
+
+{{ template "footer" . }}

templates/benchmark/view.tmpl

@@ -3,8 +3,12 @@
 <div class="row">
   <h2>{{ .benchmark.Name }}</h2>
 
+  <span><a href="/benchmark/{{ .benchmark.ID }}/edit">Edit</a></span>
+
   <p>{{ .benchmark.ScoringType }}</p>
 
+  <p>{{ .benchmark.Description }}</p>
+
   <hr>
 
   <h4>Latest Benchmark Results:</h4>

templates/hardware/edit.tmpl

@@ -0,0 +1,34 @@
+{{ template "header" . }}
+
+<div class="row">
+  <h2>Add new hardware</h2>
+
+  <form class="twelve columns" action="/hardware/{{ .hardware.ID }}/edit" method="POST">
+    <div class="row">
+      <div class="nine columns">
+        <label for="hardware_name">
+          Hardware name:
+          <input id="hardware_name" class="u-full-width" type="text" name="hardware_name" placeholder="EVGA RTX 3080 Ti" value="{{ .hardware.Name }}">
+        </label>
+      </div>
+
+      <div class="three columns">
+        <label for="hardware_type">
+          Hardware type:
+          <select id="hardware_type" class="u-full-width" name="hardware_type">
+            <option value="cpu" {{ if eq .hardware.Type "cpu" }}selected{{ end }}>Processor</option>
+            <option value="mem" {{ if eq .hardware.Type "mem" }}selected{{ end }}>Memory</option>
+            <option value="gpu" {{ if eq .hardware.Type "gpu" }}selected{{ end }}>Graphics Card</option>
+            <option value="ssd" {{ if eq .hardware.Type "ssd" }}selected{{ end }}>Solid State Drive</option>
+            <option value="hdd" {{ if eq .hardware.Type "hdd" }}selected{{ end }}>Hard Drive</option>
+            <option value="nic" {{ if eq .hardware.Type "nic" }}selected{{ end }}>Network Card</option>
+          </select>
+        </label>
+      </div>
+    </div>
+
+    <input class="button-primary u-full-width" type="submit" value="Submit">
+  </form>
+</div>
+
+{{ template "footer" . }}

templates/hardware/view.tmpl

@@ -3,6 +3,8 @@
 <div class="row">
   <h2>{{ .hardware.Name }}</h2>
 
+  <span><a href="/hardware/{{ .hardware.ID }}/edit">Edit</a></span>
+
   <p>{{ .hardware.Type }}</p>
 
   <hr>

templates/test/edit.tmpl

@@ -30,9 +30,9 @@
         <label for="test_benchmarks">
           Benchmarks to Test:
           <select id="test_benchmarks" class="u-full-width" name="test_benchmarks" multiple>
-            {{ $testBenchmarks := .test.Benchmarks }}
+            {{ $selectedBenchmarks := .selectedBenchmarks }}
             {{ range $bm := .benchmarks }}
-              <option value="{{ $bm.ID }}" {{ if contains $testBenchmarks $bm.ID }}selected{{ end }}>{{ $bm.Name }}</option>
+              <option value="{{ $bm.ID }}" {{ if contains $selectedBenchmarks $bm.StringID }}selected{{ end }}>{{ $bm.Name }}</option>
             {{ end }}
           </select>
         </label>

templates/test/view.tmpl

@@ -3,11 +3,15 @@
 <div class="row">
   <h2>{{ .test.Name }}</h2>
 
-  <p>Hardware tested: <a href="/hardware/{{ .test.Hardware.ID }}">{{ .test.Hardware.Name }}</a></p>
+  <span><a href="/test/{{ .test.ID }}/edit">Edit</a></span>
 
   <p>{{ .test.Description }}</p>
 
-  <h4>Benchmarks used:</h4>
+  <h4>Test Info:</h4>
+
+  <p>Hardware tested: <a href="/hardware/{{ .test.Hardware.ID }}">{{ .test.Hardware.Name }}</a></p>
+
+  <p>Benchmarks used:</p>
 
   <ul>
     {{ range $bm := .test.Benchmarks }}

web/forms/test.go

@@ -4,5 +4,15 @@ type TestForm struct {
   Name        string    `form:"test_name" validate:"required"`
   Description string    `form:"test_description"`
   Hardware    int       `form:"test_hardware" validate:"required"`
-  Benchmarks  []string  `form:"test_benchmarks" validate:"required"`
+  Benchmarks  []uint  `form:"test_benchmarks" validate:"required"`
+}
+
+func (t *TestForm) IsBenchmarkSelected(checkID uint) bool {
+  for _, selectedID := range t.Benchmarks {
+    if checkID == selectedID {
+      return true
+    }
+  }
+
+  return false
 }

web/routes.go

@@ -24,6 +24,9 @@ func RegisterRoutes(f *flamego.Flame) {
     f.Post("/create", binding.Form(forms.HardwareForm{}), routes.HardwarePostCreate)
 
     f.Get("/{hardware_id}", routes.HardwareGetView)
+
+    f.Get("/{hardware_id}/edit", routes.HardwareGetEdit)
+    f.Post("/{hardware_id}/edit", binding.Form(forms.HardwareForm{}), routes.HardwarePostEdit)
   })
 
   // benchmark routes
@@ -38,6 +41,9 @@ func RegisterRoutes(f *flamego.Flame) {
     f.Post("/create", binding.Form(forms.BenchmarkForm{}), routes.BenchmarkPostCreate)
 
     f.Get("/{benchmark_id}", routes.BenchmarkGetView)
+
+    f.Get("/{benchmark_id}/edit", routes.BenchmarkGetEdit)
+    f.Post("/{benchmark_id}/edit", binding.Form(forms.BenchmarkForm{}), routes.BenchmarkPostEdit)
   })
 
   // test routes
@@ -54,6 +60,7 @@ func RegisterRoutes(f *flamego.Flame) {
     f.Group("/{test_id}", func() {
       f.Get("", routes.TestGetView)
       f.Get("/edit", routes.TestGetEdit)
+      f.Post("/edit", binding.Form(forms.TestForm{}), routes.TestPostEdit)
     })
   })
 

web/routes/benchmark.go

@@ -64,3 +64,44 @@ func BenchmarkPostCreate(c flamego.Context, form forms.BenchmarkForm, errs bindi
 
   c.Redirect(fmt.Sprintf("/benchmark/%d", benchmark.ID))
 }
+
+func BenchmarkGetEdit(c flamego.Context, t template.Template, data template.Data) {
+  // find benchmark ID from request
+  benchmarkID := c.Param("benchmark_id")
+
+  // find benchmark from DB
+  var benchmark models.Benchmark
+  models.DB.First(&benchmark, benchmarkID)
+  data["benchmark"] = benchmark
+
+  data["title"] = "Editing Benchmark"
+  t.HTML(http.StatusOK, "benchmark/edit")
+}
+
+func BenchmarkPostEdit(c flamego.Context, form forms.BenchmarkForm, errs binding.Errors) {
+  if len(errs) > 0 {
+    var err error
+    switch errs[0].Category {
+    case binding.ErrorCategoryValidation:
+      err = errs[0].Err.(validator.ValidationErrors)[0]
+    default:
+      err = errs[0].Err
+    }
+    log.Fatal(err)
+  }
+
+  // find benchmark ID from request
+  benchmarkID := c.Param("benchmark_id")
+
+  // find benchmark from DB
+  var benchmark models.Benchmark
+  models.DB.First(&benchmark, benchmarkID)
+
+  benchmark.Name = form.Name
+  benchmark.ScoringType = form.ScoringType
+  benchmark.Description = form.Description
+
+  models.DB.Save(&benchmark)
+
+  c.Redirect(fmt.Sprintf("/benchmark/%d", benchmark.ID))
+}

web/routes/hardware.go

@@ -63,3 +63,43 @@ func HardwarePostCreate(c flamego.Context, form forms.HardwareForm, errs binding
 
   c.Redirect(fmt.Sprintf("/hardware/%d", hardware.ID))
 }
+
+func HardwareGetEdit(c flamego.Context, t template.Template, data template.Data) {
+  // find hardware ID from request
+  hardwareID := c.Param("hardware_id")
+
+  // find hardware from DB
+  var hardware models.Hardware
+  models.DB.Preload("Tests.Benchmarks").First(&hardware, hardwareID)
+  data["hardware"] = hardware
+
+  data["title"] = "Edit Hardware"
+  t.HTML(http.StatusOK, "hardware/edit")
+}
+
+func HardwarePostEdit(c flamego.Context, form forms.HardwareForm, errs binding.Errors) {
+  if len(errs) > 0 {
+    var err error
+    switch errs[0].Category {
+    case binding.ErrorCategoryValidation:
+      err = errs[0].Err.(validator.ValidationErrors)[0]
+    default:
+      err = errs[0].Err
+    }
+    log.Fatal(err)
+  }
+
+  // find hardware ID from request
+  hardwareID := c.Param("hardware_id")
+
+  // find hardware from DB
+  var hardware models.Hardware
+  models.DB.Preload("Tests.Benchmarks").First(&hardware, hardwareID)
+
+  hardware.Name = form.Name
+  hardware.Type = form.Type
+
+  models.DB.Save(&hardware)
+
+  c.Redirect(fmt.Sprintf("/hardware/%d", hardware.ID))
+}

web/routes/test.go

@@ -99,6 +99,56 @@ func TestGetEdit(c flamego.Context, t template.Template, data template.Data) {
   models.DB.Find(&benchmarks)
   data["benchmarks"] = benchmarks
 
+  // determine which benchmarks are selected in a test
+  selectedBenchmarks := test.SelectedBenchmarks()
+  data["selectedBenchmarks"] = selectedBenchmarks
+
   data["title"] = fmt.Sprintf("Editing Test: %s", test.Name)
   t.HTML(http.StatusOK, "test/edit")
 }
+
+func TestPostEdit(c flamego.Context, form forms.TestForm, errs binding.Errors) {
+  if len(errs) > 0 {
+    var err error
+    switch errs[0].Category {
+    case binding.ErrorCategoryValidation:
+      err = errs[0].Err.(validator.ValidationErrors)[0]
+    default:
+      err = errs[0].Err
+    }
+    log.Fatal(err)
+  }
+
+  // find test ID from request
+  testID := c.Param("test_id")
+
+  // find hardware from DB
+  var test models.Test
+  models.DB.Preload("Hardware").Preload("Benchmarks").First(&test, testID)
+
+  test.Name = form.Name
+  test.Description = form.Description
+  test.HardwareID = form.Hardware
+
+  // bind benchmarks to test that aren't already associated
+  for _, b := range form.Benchmarks {
+    if ! test.IsBenchmarkSelected(b) {
+      var benchmark models.Benchmark
+      models.DB.First(&benchmark, b) // find benchmark
+      models.DB.Model(&test).Association("Benchmarks").Append(&benchmark)
+    }
+  }
+
+  // removed associated benchmarks that weren't in the form
+  for _, b := range test.Benchmarks {
+    if ! form.IsBenchmarkSelected(b.ID) {
+      var benchmark models.Benchmark
+      models.DB.First(&benchmark, b) // find benchmark
+      models.DB.Model(&test).Association("Benchmarks").Delete(&benchmark)
+    }
+  }
+
+  models.DB.Save(&test)
+
+  c.Redirect(fmt.Sprintf("/test/%d", test.ID))
+}