Add dummy Rails app test suite and add Github CI workflow

westonganger · westonganger · commit 4bc369ec5e12 · 2023-11-02T21:20:06.000-07:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,54 @@
+name: Test
+on:
+  push:
+    branches: ['master']
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    env:
+      RAILS_ENV: test
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          ### TEST RUBY VERSIONS
+          - ruby: "2.5"
+          - ruby: "2.6"
+          - ruby: "2.7"
+          - ruby: "3.0"
+          - ruby: "3.1"
+          - ruby: "3.2"
+          ### TEST RAILS VERSIONS
+          - ruby: "2.6"
+            env:
+              RAILS_VERSION: "5.2"
+          - ruby: "2.6"
+            env:
+              RAILS_VERSION: "6.0"
+          - ruby: "2.6"
+            env:
+              RAILS_VERSION: "6.1"
+          - ruby: "3.2"
+            env:
+              RAILS_VERSION: "7.0"
+          - ruby: "3.2"
+            env:
+              RAILS_VERSION: "7.1"
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+        bundler-cache: false ### not compatible with ENV style gemfile
+
+    - name: Run test
+      run: |
+        bundle install
+        bundle exec rake test
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,6 @@
 /test/*.sqlite3*
 /production/*.sqlite3*
 .DS_Store
+/test/dummy_app/**/*.sqlite3*
+/test/dummy_app/**/*.log
+/test/dummy_app/tmp/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 - Fix Litesearch tests
 - Suppress chatty Litejob exit detector when there are no jobs in flight
 - Tidy up the test folder
+- [#xx](https://github.com/oldmoe/litestack/pull/xx) - Add dummy Rails app for test suite and Github CI workflow
 
 ## [0.4.1] - 2023-10-11
 
diff --git a/Gemfile b/Gemfile
@@ -4,3 +4,9 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in litestack.gemspec
 gemspec
+
+def get_env(name)
+  (ENV[name] && !ENV[name].empty?) ? ENV[name] : nil
+end
+
+gem 'rails', get_env("RAILS_VERSION")
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 ![litestack](https://github.com/oldmoe/litestack/blob/master/assets/litestack_logo_teal_large.png?raw=true)
 
+<a href='https://github.com/oldmoe/litestack/actions' target='_blank'><img src="https://github.com/oldmoe/litestack/actions/workflows/test.yml/badge.svg?branch=master" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+
 All your data infrastructure, in a gem!
 
 Litestack is a Ruby gem that provides both Ruby and  Ruby on Rails applications an all-in-one solution for web application data infrastructure. It exploits the power and embeddedness of SQLite to deliver a full-fledged SQL database, a fast cache , a robust job queue, a reliable message broker, a full text search engine and a metrics platform all in a single package.
@@ -105,37 +107,37 @@ In your desired environment file (e.g. production.rb)
 ```ruby
 config.cache_store = :litecache, {path: './path/to/your/cache/file'}
 ```
-This provides a transparent integration that uses the Rails caching interface 
+This provides a transparent integration that uses the Rails caching interface
 
 litecache spawns a background thread for cleanup purposes. In case it detects that the current environment has *Fiber::Scheduler* or *Polyphony* loaded it will spawn a fiber instead, saving on both memory and CPU cycles.
 
 > ![litejob](https://github.com/oldmoe/litestack/blob/master/assets/litejob_logo_teal.png?raw=true)
 
 More info about Litejob can be found in the [litejob guide](https://github.com/oldmoe/litestack/wiki/Litejob-guide)
 
-litejob is a fast and very efficient job queue processor for Ruby applications. It builds on top of SQLite as well, which provides transactional guarantees, persistence and exceptional performance. 
+litejob is a fast and very efficient job queue processor for Ruby applications. It builds on top of SQLite as well, which provides transactional guarantees, persistence and exceptional performance.
 
 #### Direct litejob usage
 ```ruby
 require 'litestack'
 # define your job class
 class MyJob
   include ::Litejob
-      
+
   queue = :default
-      
+
   # must implement perform, with any number of params
   def perform(params)
     # do stuff
   end
 end
-    
+
 #schedule a job asynchronusly
 MyJob.perform_async(params)
-    
+
 #schedule a job at a certain time
 MyJob.perform_at(time, params)
-    
+
 #schedule a job after a certain delay
 MyJob.perform_after(delay, params)
 ```
@@ -202,7 +204,7 @@ idx.add({sender: 'Kamal', receiver: 'Laila', subject: 'Are the girls awake?', bo
 # search the index, all fields
 idx.search('kamal')
 # search the index, specific field, partial workd (trigram)
-idx.search('subject: awa') 
+idx.search('subject: awa')
 ```
 
 Litesearch integrates tightly with ActiveRecord ans Sequel, here are integration examples
@@ -226,8 +228,8 @@ class Book < ActiveRecord::Base
     end
 end
 # insert records
-Author.create(name: 'Adam A. Writer') 
-Book.create(title: 'The biggest stunt', author_id: 1, description: 'a description') 
+Author.create(name: 'Adam A. Writer')
+Book.create(title: 'The biggest stunt', author_id: 1, description: 'a description')
 # search the index, the search method integrates with AR's query interface
 Book.search('author: writer').limit(1).all
 ```
@@ -249,8 +251,8 @@ class Book < Sequel::Model
     end
 end
 # insert records
-Author.create(name: 'Adam A. Writer') 
-Book.create(title: 'The biggest stunt', author_id: 1, description: 'a description') 
+Author.create(name: 'Adam A. Writer')
+Book.create(title: 'The biggest stunt', author_id: 1, description: 'a description')
 # search the index, the search method integrates with Sequel's query interface
 Book.search('author: writer').limit(1).all
 ```
diff --git a/test/dummy_app/Rakefile b/test/dummy_app/Rakefile
@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks
diff --git a/test/dummy_app/app/assets/config/manifest.js b/test/dummy_app/app/assets/config/manifest.js
@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css .scss
diff --git a/test/dummy_app/app/assets/javascripts/application.js b/test/dummy_app/app/assets/javascripts/application.js
diff --git a/test/dummy_app/app/assets/stylesheets/application.css b/test/dummy_app/app/assets/stylesheets/application.css
@@ -0,0 +1,3 @@
+/*
+ *= require_self
+*/
diff --git a/test/dummy_app/app/channels/application_cable.rb b/test/dummy_app/app/channels/application_cable.rb
@@ -0,0 +1,7 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+
+  class Connection < ActionCable::Connection::Base
+  end
+end
diff --git a/test/dummy_app/app/controllers/application_controller.rb b/test/dummy_app/app/controllers/application_controller.rb
@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end
diff --git a/test/dummy_app/app/jobs/application_job.rb b/test/dummy_app/app/jobs/application_job.rb
@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end
diff --git a/test/dummy_app/app/mailers/.gitkeep b/test/dummy_app/app/mailers/.gitkeep
diff --git a/test/dummy_app/app/models/application_record.rb b/test/dummy_app/app/models/application_record.rb
@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end
diff --git a/test/dummy_app/app/models/comment.rb b/test/dummy_app/app/models/comment.rb
@@ -0,0 +1,3 @@
+class Comment < ApplicationRecord
+  belongs_to :post
+end
diff --git a/test/dummy_app/app/models/post.rb b/test/dummy_app/app/models/post.rb
@@ -0,0 +1,3 @@
+class Post < ApplicationRecord
+  has_many :comments
+end
diff --git a/test/dummy_app/app/views/layouts/application.html.erb b/test/dummy_app/app/views/layouts/application.html.erb
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy App</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>
diff --git a/test/dummy_app/config.ru b/test/dummy_app/config.ru
@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application
diff --git a/test/dummy_app/config/application.rb b/test/dummy_app/config/application.rb
@@ -0,0 +1,48 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    config.generators.test_framework = false
+    config.generators.helper = false
+    config.generators.stylesheets = false
+    config.generators.javascripts = false
+
+    config.after_initialize do
+      ActiveRecord::Migration.migrate(Rails.root.join("db/migrate/*").to_s)
+    end
+  end
+end
diff --git a/test/dummy_app/config/boot.rb b/test/dummy_app/config/boot.rb
@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)
diff --git a/test/dummy_app/config/cable.yml b/test/dummy_app/config/cable.yml
@@ -0,0 +1,6 @@
+development:
+  adapter: litecable
+
+test:
+  adapter: test
+  #adapter: litecable
diff --git a/test/dummy_app/config/database.yml b/test/dummy_app/config/database.yml
@@ -0,0 +1,7 @@
+development:
+  adapter: litedb
+  database: db/development/database.sqlite3.db
+
+test:
+  adapter: litedb
+  database: db/test/database.sqlite3.db
diff --git a/test/dummy_app/config/environment.rb b/test/dummy_app/config/environment.rb
@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!
diff --git a/test/dummy_app/config/environments/test.rb b/test/dummy_app/config/environments/test.rb
@@ -0,0 +1,41 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+
+  config.eager_load = false
+end
diff --git a/test/dummy_app/config/initializers/backtrace_silencers.rb b/test/dummy_app/config/initializers/backtrace_silencers.rb
@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!
diff --git a/test/dummy_app/config/initializers/inflections.rb b/test/dummy_app/config/initializers/inflections.rb
@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
diff --git a/test/dummy_app/config/initializers/mime_types.rb b/test/dummy_app/config/initializers/mime_types.rb
@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone
diff --git a/test/dummy_app/config/initializers/secret_token.rb b/test/dummy_app/config/initializers/secret_token.rb
@@ -0,0 +1,11 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+
+gem_version = ActiveRecord.gem_version
+if gem_version <= Gem::Version.new("5.1")
+  Dummy::Application.config.secret_token = '4f337f0063fbb4a724dd8da15419679300da990ae4f6c94d36c714a3cd07e9653fc42d902cf33a9b9449a28e7eb2673f928172d65a090fa3c9156d6beea8d16c'
+end
diff --git a/test/dummy_app/config/initializers/session_store.rb b/test/dummy_app/config/initializers/session_store.rb
@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store
diff --git a/test/dummy_app/config/initializers/wrap_parameters.rb b/test/dummy_app/config/initializers/wrap_parameters.rb
diff --git a/test/dummy_app/config/locales/en.yml b/test/dummy_app/config/locales/en.yml
diff --git a/test/dummy_app/config/routes.rb b/test/dummy_app/config/routes.rb
diff --git a/test/dummy_app/config/secrets.yml b/test/dummy_app/config/secrets.yml
diff --git a/test/dummy_app/db/migrate/20231102155312_setup_test_tables.rb b/test/dummy_app/db/migrate/20231102155312_setup_test_tables.rb
diff --git a/test/dummy_app/log/.gitkeep b/test/dummy_app/log/.gitkeep
diff --git a/test/models/.gitkeep b/test/models/.gitkeep
diff --git a/test/rails_helper.rb b/test/rails_helper.rb
diff --git a/test/request/.gitkeep b/test/request/.gitkeep
diff --git a/test/system/.gitkeep b/test/system/.gitkeep
diff --git a/test/test_helper.rb b/test/test_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+//= link_tree ../images`
	`2`	`+//= link_directory ../javascripts .js`
	`3`	`+//= link_directory ../stylesheets .css .scss`