Added some more tests; changed URLs for model list pages and added redirects

.rubocop.yml

@@ -1,4 +1,6 @@
-require: rubocop-sequel
+plugins:
+  - rubocop-rspec
+  - rubocop-sequel
 
 AllCops:
   NewCops: enable

Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'sinatra', '~> 3.2'
+gem 'sinatra', '~> 4.1'
-gem 'sinatra-contrib', '~> 3.2'
+gem 'sinatra-contrib', '~> 4.1'
 gem 'puma', '~> 6.6'
 
 gem 'sequel', '~> 5.92'
@@ -15,5 +15,11 @@ group :development, :test do
 
   # rubocop and extensions for code style
   gem 'rubocop'
+  gem 'rubocop-rspec'
   gem 'rubocop-sequel'
 end
+
+group :test do
+  gem 'rspec'
+  gem 'rack-test'
+end

Gemfile.lock

@@ -4,6 +4,7 @@ GEM
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (3.2.2)
+    diff-lcs (1.6.2)
     ffi (1.17.2-aarch64-linux-gnu)
     ffi (1.17.2-aarch64-linux-musl)
     ffi (1.17.2-arm-linux-gnu)
@@ -33,10 +34,16 @@ GEM
     puma (6.6.0)
       nio4r (~> 2.0)
     racc (1.8.1)
-    rack (2.2.17)
+    rack (3.2.0)
-    rack-protection (3.2.0)
+    rack-protection (4.1.1)
       base64 (>= 0.1.0)
-      rack (~> 2.2, >= 2.2.4)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
@@ -44,6 +51,19 @@ GEM
     regexp_parser (2.10.0)
     rerun (0.14.0)
       listen (~> 3.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
     rubocop (1.76.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -58,6 +78,9 @@ GEM
     rubocop-ast (1.45.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     rubocop-sequel (0.4.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1, < 2)
@@ -65,16 +88,18 @@ GEM
     ruby2_keywords (0.0.5)
     sequel (5.93.0)
       bigdecimal
-    sinatra (3.2.0)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
       mustermann (~> 3.0)
-      rack (~> 2.2, >= 2.2.4)
+      rack (>= 3.0.0, < 4)
-      rack-protection (= 3.2.0)
+      rack-protection (= 4.1.1)
+      rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    sinatra-contrib (3.2.0)
+    sinatra-contrib (4.1.1)
       multi_json (>= 0.0.2)
       mustermann (~> 3.0)
-      rack-protection (= 3.2.0)
+      rack-protection (= 4.1.1)
-      sinatra (= 3.2.0)
+      sinatra (= 4.1.1)
       tilt (~> 2.0)
     sqlite3 (2.7.0-aarch64-linux-gnu)
     sqlite3 (2.7.0-aarch64-linux-musl)
@@ -106,12 +131,15 @@ PLATFORMS
 DEPENDENCIES
   logger
   puma (~> 6.6)
+  rack-test
   rerun
+  rspec
   rubocop
+  rubocop-rspec
   rubocop-sequel
   sequel (~> 5.92)
-  sinatra (~> 3.2)
+  sinatra (~> 4.1)
-  sinatra-contrib (~> 3.2)
+  sinatra-contrib (~> 4.1)
   sqlite3 (~> 2.6)
 
 BUNDLED WITH

Rakefile

@@ -24,8 +24,12 @@ namespace :server do
 end
 
 namespace :test do
+  task :unit do
+    system("rspec")
+  end
+
   task :rubocop do
-    system("rubocop src/")
+    system("rubocop src/ spec/")
   end
 end
 

assets/scripts/edgeville.coffee

@@ -1,3 +1,21 @@
 $ ->
   # run foundation scripts
   console.log('Ready.')
+
+averageResults = (results, decimals = 2) ->
+  avgScore = 0
+  minScore = Infinity
+  maxScore = -Infinity
+
+  factor = (10 ^ decimals)
+
+  for result in results
+    avgScore += result.avg_score
+    minScore = Math.min(minScore, result.min_score)
+    maxScore = Math.max(maxScore, result.max_score)
+
+  return {
+    avgScore: Math.round((avgScore / results.length) * factor) / factor,
+    minScore: minScore,
+    maxScore: maxScore,
+  }

assets/scripts/reports.coffee

@@ -1,6 +1,9 @@
 $ ->
   chartInstance = null
 
+  $('#report-benchmarks').on 'change', (e) ->
+    $('#report-tests option').prop('selected', false)
+
   $('#reports-download').on 'click', (e) ->
     e.preventDefault()
     canvas = $('#benchmark-chart')[0]
@@ -64,21 +67,14 @@ $ ->
         resultRes = await fetch("/api/v1/result/list?#{resultSearchParams}")
         resultData = await resultRes.json()
 
-        avg_total = 0
+        resultAverage = averageResults(resultData)
-        min_total = 0
-        max_total = 0
-
-        for result in resultData
-          avg_total += result.avg_score
-          min_total += result.min_score if result.min_score
-          max_total += result.max_score if result.max_score
 
         data.labels.push(testData.name)
-        data.datasets[0].data.push(avg_total / resultData.length)
+        data.datasets[0].data.push(resultAverage.avgScore)
         console.log(data.datasets[0].data)
         switch benchmarkData.scoring
           when 'fps', 'ms'
-            data.datasets[1].data.push(min_total / resultData.length)
+            data.datasets[1].data.push(resultAverage.minScore)
       catch error
         console.error 'An error occurred while fetching benchmark results.', error
 

assets/scripts/test.coffee

@@ -13,14 +13,7 @@ fetchTestBenchmarkResults = (testId, benchmarkId) ->
 		resultRes = await fetch("/api/v1/result/list?#{resultSearchParams}")
 		resultData = await resultRes.json()
 
-		avg_total = 0
+		resultAverage = averageResults(resultData)
-		min_total = 0
-		max_total = 0
-
-		for result in resultData
-			avg_total += result.avg_score
-			min_total += result.min_score
-			max_total += result.max_score
 
 		tableRow = $("#results-table tr[data-benchmark-id=#{benchmarkId}]")
 
@@ -29,14 +22,16 @@ fetchTestBenchmarkResults = (testId, benchmarkId) ->
 		tableRow.append('<td>' + resultData.length + '</td>')
 
 		if resultData.length != 0
-			tableRow.append('<td>' + (avg_total / resultData.length) + '</td>')
+			tableRow.append('<td>' + resultAverage.avgScore + '</td>')
+
+			if benchmarkData.scoring == 'fps'
+				tableRow.append('<td>' + resultAverage.minScore + '</td>')
+				tableRow.append('<td>' + resultAverage.maxScore + '</td>')
+			else
+				tableRow.append('<td>N/a</td>')
+				tableRow.append('<td>N/a</td>')
 		else
 			tableRow.append('<td>N/a</td>')
-
-		if min_total != 0
-			tableRow.append('<td>' + (min_total / resultData.length) + '</td>')
-			tableRow.append('<td>' + (max_total / resultData.length) + '</td>')
-		else
 			tableRow.append('<td>N/a</td>')
 			tableRow.append('<td>N/a</td>')
 	catch error

config.ru

@@ -1,6 +1,4 @@
 # Load application config
-require_relative 'src/config.rb'
-$conf = Config.new(File.join(__dir__, 'config/defaults.yaml'))
 
 root = ::File.dirname(__FILE__)
 require ::File.join( root, 'src', 'server' )

spec/controllers/benchmark_controller_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+RSpec.describe(BenchmarkController) do
+  # /benchmark - redirects to /benchmark/list
+  describe 'GET /benchmark' do
+    before { get '/benchmark' }
+
+    it 'Benchmark base route redirects to /benchmark/list' do
+      expect(last_response).to(be_redirect)
+      expect(last_response['Location']).to(eq("#{BASE_URL}/benchmark/list"))
+    end
+  end
+
+  # /benchmark/list - displays a table of benchmarks
+  describe 'GET /benchmark/list' do
+    before { get '/benchmark/list' }
+
+    it 'Benchmark list page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Benchmark list page contains 'List of benchmarks' on page." do
+      expect(last_response.body).to(include('List of benchmarks'))
+    end
+  end
+
+  # /benchmark/add - form for adding benchmark
+  describe 'GET /benchmark/add' do
+    before { get '/benchmark/add' }
+
+    it 'Benchmark add page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Benchmark add page contains 'Add new benchmark' on page." do
+      expect(last_response.body).to(include('Add new benchmark'))
+    end
+  end
+end

spec/controllers/hardware_controller_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+RSpec.describe(HardwareController) do
+  # /hardware - redirects to /hardware/list
+  describe 'GET /hardware' do
+    before { get '/hardware' }
+
+    it 'Hardware base route redirects to /hardware/list' do
+      expect(last_response).to(be_redirect)
+      expect(last_response['Location']).to(eq("#{BASE_URL}/hardware/list"))
+    end
+  end
+
+  # /hardware/list - displays a table of hardwares
+  describe 'GET /hardware/list' do
+    before { get '/hardware/list' }
+
+    it 'Hardware list page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Hardware list page contains 'List of hardware' on page." do
+      expect(last_response.body).to(include('List of hardware'))
+    end
+  end
+
+  # /hardware/add - form for adding hardware
+  describe 'GET /hardware/add' do
+    before { get '/hardware/add' }
+
+    it 'Hardware add page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Hardware add page contains 'Add new hardware' on page." do
+      expect(last_response.body).to(include('Add new hardware'))
+    end
+  end
+end

spec/controllers/index_controller_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+RSpec.describe(IndexController) do
+  describe 'GET /' do
+    before { get '/' }
+
+    it 'Dashboard returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Dashboard contains 'Game Data' on page (nav bar should be loaded)." do
+      expect(last_response.body).to(include('Game Data'))
+    end
+
+    it "Dashboard contains 'Ruby version' on page (footer should be loaded)." do
+      expect(last_response.body).to(include('Ruby version'))
+    end
+  end
+end

spec/controllers/reports_controller_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+RSpec.describe(ReportsController) do
+  describe 'GET /report' do
+    before { get '/report' }
+
+    it 'Reports page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Reports page contains 'Generate report' on page." do
+      expect(last_response.body).to(include('Generate report'))
+    end
+  end
+end

spec/controllers/test_controller_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+
+RSpec.describe(TestController) do
+  # /test - redirects to /test/list
+  describe 'GET /test' do
+    before { get '/test' }
+
+    it 'Test base route redirects to /test/list' do
+      expect(last_response).to(be_redirect)
+      expect(last_response['Location']).to(eq("#{BASE_URL}/test/list"))
+    end
+  end
+
+  # /test/list - displays a table of tests
+  describe 'GET /test/list' do
+    before { get '/test/list' }
+
+    it 'Test list page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Test list page contains 'List of tests' on page." do
+      expect(last_response.body).to(include('List of tests'))
+    end
+  end
+
+  # /test/add - form for adding test
+  describe 'GET /test/add' do
+    before { get '/test/add' }
+
+    it 'Test add page returns 200.' do
+      expect(last_response).to(be_ok)
+    end
+
+    it "Test add page contains 'Add new test' on page." do
+      expect(last_response.body).to(include('Add new test'))
+    end
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+ENV['APP_ENV'] = 'test'
+
+require_relative '../src/server'
+require 'rspec'
+require 'rack/test'
+
+# setting this here so all redirect tests can reference the same base URL
+BASE_URL = 'http://example.org'
+
+module RSpecMixin
+
+  include Rack::Test::Methods
+
+  def app
+    GameData
+  end
+
+end
+
+RSpec.configure do |config|
+  config.include(RSpecMixin)
+end

src/controllers/api1.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
+require 'sinatra/json'
+
+require_relative 'base_controller'
+require_relative '../models/benchmark'
+require_relative '../models/test'
+require_relative '../models/result'
+
 # /api/v1 routes
-class GameData < Sinatra::Base
+class APIv1Controller < BaseController
 
   get '/api/v1/benchmark/details' do
     benchmark_id = params[:benchmark_id]

src/controllers/base_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
+# BaseController - base modular Sinatra app class
+class BaseController < Sinatra::Base
+
+  # Register view helpers
+  require_relative '../helpers'
+  helpers Helpers
+
+  # Set up our view engine
+  set :views, File.join(settings.root, '/../../views')
+
+end

src/controllers/benchmark.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'base_controller'
+require_relative '../models/benchmark'
+
 # /benchmark routes
-class GameData < Sinatra::Base
+class BenchmarkController < BaseController
 
   get '/benchmark' do
+    redirect('/benchmark/list')
+  end
+
+  get '/benchmark/list' do
     benchmarks = Benchmark.reverse(:updated_at).limit(10).all()
 
     erb :'benchmark/index', locals: {

src/controllers/hardware.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'base_controller'
+require_relative '../models/hardware'
+require_relative '../models/benchmark'
+
 # /hardware routes
-class GameData < Sinatra::Base
+class HardwareController < BaseController
 
   get '/hardware' do
+    redirect('/hardware/list')
+  end
+
+  get '/hardware/list' do
     hardware = Hardware.reverse(:updated_at).limit(10).all()
 
     erb :'hardware/index', locals: {

src/controllers/index.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'base_controller'
+require_relative '../models/test'
+
 # / (top-level) routes
-class GameData < Sinatra::Base
+class IndexController < BaseController
 
   get '/' do
     tests = Test.reverse(:updated_at).limit(10).all()

src/controllers/reports.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
+require 'sinatra/json'
+
+require_relative 'base_controller'
+require_relative '../models/benchmark'
+require_relative '../models/result'
+require_relative '../models/test'
+
 # /reports routes
-class GameData < Sinatra::Base
+class ReportsController < BaseController
 
   get '/report' do
     benchmarks = Benchmark.order(:name).all()

src/controllers/result.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'base_controller'
+require_relative '../models/result'
+
 # /result routes
-class GameData < Sinatra::Base
+class ResultController < BaseController
 
   post '/result/add' do
     result_minimum = params[:result_minimum] if params.key?(:result_minimum)

src/controllers/test.rb

@@ -1,9 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'base_controller'
+require_relative '../models/benchmark'
+require_relative '../models/hardware'
+require_relative '../models/test'
+
 # /test routes
-class GameData < Sinatra::Base
+class TestController < BaseController
 
   get '/test' do
+    redirect('/test/list')
+  end
+
+  get '/test/list' do
     tests = Test.reverse(:updated_at).limit(10).all()
 
     erb :'test/index', locals: {
@@ -65,9 +74,22 @@ class GameData < Sinatra::Base
 
     tst.update(
       name: params[:test_name],
-      type: params[:test_type]
+      hardware_id: params[:test_hardware],
+      description: params[:test_description]
     )
 
+    selected_benchmarks = Array(params[:test_benchmarks])
+
+    # remove benchmarks no longer associated with the test
+    tst.benchmarks.dup.each do |b|
+      tst.remove_benchmark(b.id) unless selected_benchmarks.include?(b.id)
+    end
+
+    # associate the benchmarks to the test
+    selected_benchmarks.each do |b|
+      tst.add_benchmark(b) unless tst.benchmark?(b)
+    end
+
     redirect "/test/#{tst.id}"
   end
 

src/helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'appinfo'
+
 # Helpers - view helper functions
 module Helpers
 

src/models/init.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'hardware'
-require_relative 'benchmark'
-require_relative 'result'
-require_relative 'test'

src/models/test.rb

@@ -7,4 +7,8 @@ class Test < Sequel::Model
   many_to_one :hardware
   many_to_many :benchmarks
 
+  def benchmark?(benchmark_id)
+    return benchmarks_dataset.where(Sequel[:benchmarks][:id] => benchmark_id).any?
+  end
+
 end

src/routes/init.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'index'
-require_relative 'hardware'
-require_relative 'benchmark'
-require_relative 'reports'
-require_relative 'result'
-require_relative 'test'
-
-require_relative 'api1'

src/server.rb

@@ -1,18 +1,31 @@
 # frozen_string_literal: true
 
 require 'sinatra/base'
-require 'sinatra/json'
 require 'sequel'
 require 'sqlite3'
 
-require_relative 'appinfo'
+require_relative 'config'
+
+$conf = Config.new(File.join(__dir__, 'config/defaults.yaml'))
 
 # Load the Sequel timestamps plugin
 Sequel::Model.plugin(:timestamps)
 # Initialize Sequel gem for database actions
 DB = Sequel.connect(adapter: $conf.get('database.adapter'), database: $conf.get('database.database'))
 
-# Base app
+# Load in routes (must happen after Sequel is loaded!)
+require_relative 'controllers/api1'
+require_relative 'controllers/benchmark'
+require_relative 'controllers/hardware'
+require_relative 'controllers/index'
+require_relative 'controllers/reports'
+require_relative 'controllers/result'
+require_relative 'controllers/test'
+
+# GameData - main app that gets launched
+#   - inherits from Sinatra::Base to instantiate the server
+#   - sets up some base app configuration
+#   - registers route classes with the base app
 class GameData < Sinatra::Base
 
   enable :sessions
@@ -21,16 +34,12 @@ class GameData < Sinatra::Base
   enable :static
   set :public_folder, File.join(__dir__, '/../public')
 
-  # Register view helpers
+  use IndexController
-  require_relative 'helpers'
+  use HardwareController
-  helpers Helpers
+  use BenchmarkController
-
+  use TestController
-  # Set up our view engine
+  use ResultController
-  set :views, File.join(settings.root, '/../views')
+  use ReportsController
+  use APIv1Controller
 
 end
-
-# Load routes
-require_relative 'routes/init'
-# Load models
-require_relative 'models/init'

views/benchmark/add.erb

@@ -26,7 +26,7 @@
     <div class="row mb-3">
       <div class="col-12">
         <label for="benchmark_description">Benchmark description</label>
-        <textarea id="benchmark_description" class="form-control" name="benchmark_description">Enter a description/notes here.</textarea>
+        <textarea id="benchmark_description" class="form-control" name="benchmark_description" placeholder="Enter a description/notes here."></textarea>
       </div>
     </div>
 

views/benchmark/edit.erb

@@ -26,7 +26,7 @@
     <div class="row mb-3">
       <div class="col-12">
         <label for="benchmark_description">Benchmark description</label>
-        <textarea id="benchmark_description" class="form-control" name="benchmark_description"><%= benchmark.description %></textarea>
+        <textarea id="benchmark_description" class="form-control" name="benchmark_description" placeholder="Enter a description/notes here."><%= benchmark.description %></textarea>
       </div>
     </div>
 

views/reports/index.erb

@@ -1,3 +1,9 @@
+<div class="row">
+  <div class="col-12">
+    <h1>Generate report</h1>
+  </div>
+</div>
+
 <div class="row">
   <form class="col-12" action="/reports" method="post">
     <div class="row mb-3">

views/test/edit.erb

@@ -28,7 +28,7 @@
         <label for="test_benchmarks">Benchmarks</label>
         <select id="test_benchmarks" class="form-select" name="test_benchmarks[]" multiple>
           <% for b in benchmarks %>
-            <option value="<%= b.id %>"><%= b.name %></option>
+            <option value="<%= b.id %>" <% if test.benchmark?(b.id) %>selected<% end %>><%= b.name %></option>
             <% end %>
         </select>
       </div>
@@ -41,7 +41,7 @@
 
     <div class="row">
       <div class="col-12">
-        <input class="btn btn-primary w-100" type="submit" value="Create Test">
+        <input class="btn btn-primary w-100" type="submit" value="Submit Changes">
       </div>
     </div>
   </form>