Repository navigation
Expand file tree
/
Copy pathend2end_options.rb
More file actions
181 lines (168 loc) · 8.83 KB
/
Copy pathend2end_options.rb
File metadata and controls
181 lines (168 loc) · 8.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
#!/usr/bin/env ruby
# frozen_string_literal: true
gem 'minitest'
require 'minitest/autorun'
require 'bundler'
require 'fileutils'
require 'connection_pool'
require 'open3'
require 'pg'
require 'rbconfig'
require 'sqlite3'
require 'yaml'
class TestOptions < Minitest::Test
ROOT = File.expand_path('..', __dir__)
OPTIONS_DIR = File.join(ROOT, 'tests/options')
OUTPUT_DIR = File.join(OPTIONS_DIR, '.generated')
def test_generator_options_preserve_runtime_values_and_generate_expected_layouts
FileUtils.rm_rf(OUTPUT_DIR)
config_path = File.join(OPTIONS_DIR, ".sqlc-#{Process.pid}.yaml")
begin
config = YAML.safe_load_file(File.join(OPTIONS_DIR, 'sqlc.yaml'))
config.fetch('options').fetch('ruby')['rubyVersion'] = RUBY_VERSION.split('.')[0, 2].join('.')
# Windows cannot execute exe/plugin.rb directly; cmd.exe needs backslashes (it reads `/plugin.cmd` as a switch)
config.fetch('plugins').first.fetch('process')['cmd'] = 'exe\\plugin.cmd' if Gem.win_platform?
File.write(config_path, config.to_yaml)
assert system('sqlc', 'generate', '-f', config_path, chdir: ROOT)
sqlite_dir = File.join(OUTPUT_DIR, 'sqlite3')
pg_dir = File.join(OUTPUT_DIR, 'pg')
assert_equal %w[admin_users_sql.rb admin_users_sql.rbs first_sql.rb first_sql.rbs second_sql.rb second_sql.rbs models.rb
models.rbs connection.rb connection.rbs Gemfile].sort,
Dir.children(sqlite_dir).sort
refute Dir.children(pg_dir).any? { |file| file.end_with?('.rbs') }
assert File.file?(File.join(pg_dir, 'Gemfile'))
models = File.read(File.join(sqlite_dir, 'models.rb'))
%w[Author Articles Authors SQLiteItems].each { |name| assert_model_defined(models, name) }
pg_models = File.read(File.join(pg_dir, 'models.rb'))
%w[GlobalAuthors PgItems].each { |name| assert_model_defined(pg_models, name) }
rbs = File.read(File.join(sqlite_dir, 'first_sql.rbs'))
assert_match(/memo: Pathname\b/, rbs)
assert_match(/tag: Symbol\b/, rbs)
assert_match(/extra: Date\b/, rbs)
assert_match(/id: String\b/, rbs)
assert_match(/class GetBothModelsRow\b/, rbs)
assert File.file?(File.join(sqlite_dir, 'second_sql.rbs'))
admin = File.read(File.join(sqlite_dir, 'admin_users_sql.rb'))
assert_match(/^ *class AdminUsersSql$/, admin)
assert_sqlite_runtime(sqlite_dir)
assert_major_version_runtime(File.join(OUTPUT_DIR, 'sqlite3_major'))
assert_pg_runtime(pg_dir)
ensure
FileUtils.rm_rf(OUTPUT_DIR)
FileUtils.rm_f(config_path)
end
end
private
def assert_model_defined(source, name)
assert_match(/(?:^|\n)\s*(?:#{Regexp.escape(name)}\s*=\s*(?:::)?Struct\.new|class\s+#{Regexp.escape(name)}\s*<\s*(?:::)?Data\.define)/,
source)
end
def assert_sqlite_runtime(generated_dir)
bundle_env = generated_bundle_env(generated_dir, 'OPTIONS_SQLITE_DIR' => generated_dir,
'OPTIONS_SCHEMA' => File.join(OPTIONS_DIR, 'sqlite_schema.sql'))
stdout, stderr, status = Open3.capture3(bundle_env, 'bundle', 'install')
assert status.success?, "generated-Gemfile bundle install failed:\n#{stdout}\n#{stderr}"
stdout, stderr, status = Open3.capture3(
bundle_env,
'bundle', 'exec', RbConfig.ruby, '-e', <<~'RUBY'
require File.join(ENV.fetch('OPTIONS_SQLITE_DIR'), 'first_sql')
require File.join(ENV.fetch('OPTIONS_SQLITE_DIR'), 'second_sql')
require File.join(ENV.fetch('OPTIONS_SQLITE_DIR'), 'admin_users_sql')
db = SQLite3::Database.new(':memory:')
db.execute_batch(File.read(ENV.fetch('OPTIONS_SCHEMA')))
db.execute("INSERT INTO option_items VALUES (1, 'note', 'tag', 'extra')")
db.execute("INSERT INTO author VALUES (1, 'singular')")
db.execute("INSERT INTO authors VALUES (1, 'plural')")
db.execute("INSERT INTO articles VALUES (1, 'article')")
options = Options::SqliteDb
row = options::FirstSql.new(db).get_option_author(id: 1)
raise 'override changed the runtime value' unless [row.id, row.memo, row.tag, row.extra] == [1, 'note', 'tag', 'extra']
raise 'models were not shared by query files' unless options::SecondSql.new(db).get_option_extra(id: 1).extra == 'extra'
joined = options::FirstSql.new(db).get_both_models(id: 1)
raise 'embedded models were not renamed as expected' unless [joined.author.name, joined.author2.name] == %w[singular plural]
raise 'exactTableNames did not preserve the plural table model' unless options::FirstSql.new(db).list_option_articles.first.title == 'article'
raise 'admin_users.sql did not become AdminUsersSql' unless options::AdminUsersSql.new(db).count_option_articles.total == 1
RUBY
)
assert status.success?, "generated-Gemfile SQLite run failed:\n#{stdout}\n#{stderr}"
end
def generated_bundle_env(generated_dir, **env)
Bundler.unbundled_env.merge(
'BUNDLE_BIN_PATH' => nil, 'BUNDLE_PATH' => ENV['BUNDLE_PATH'], 'RUBYOPT' => nil,
'BUNDLE_GEMFILE' => File.join(generated_dir, 'Gemfile'), **env
)
end
# rubyVersion "3": the code must also work on Ruby 3.1 / 3.2 with their default timeout gem (< 0.4).
def assert_major_version_runtime(generated_dir)
assert_match(/^ *\w+ = ::Struct\.new/, File.read(File.join(generated_dir, 'models.rb')))
assert_includes File.read(File.join(generated_dir, 'Gemfile')), "gem 'timeout', '>= 0.4'"
bundle_env = generated_bundle_env(generated_dir, 'OPTIONS_DIR' => generated_dir,
'OPTIONS_SCHEMA' => File.join(OPTIONS_DIR, 'sqlite_schema.sql'))
stdout, stderr, status = Open3.capture3(bundle_env, 'bundle', 'install')
assert status.success?, "generated-Gemfile bundle install failed:\n#{stdout}\n#{stderr}"
stdout, stderr, status = Open3.capture3(
bundle_env,
'bundle', 'exec', RbConfig.ruby, '-e', <<~'RUBY'
require 'timeout'
require File.join(ENV.fetch('OPTIONS_DIR'), 'major_sql')
db = SQLite3::Database.new(':memory:')
db.execute_batch(File.read(ENV.fetch('OPTIONS_SCHEMA')))
queries = Options::SqliteMajor::MajorSql.new(db)
begin
Timeout.timeout(0.2) do
queries.transaction do |tx|
tx.create_major_article(title: 'partial')
sleep 2
end
end
raise 'Timeout did not fire'
rescue Timeout::Error
nil
end
total = queries.count_major_articles.total
raise "Timeout inside transaction committed #{total} row(s) (timeout #{Timeout::VERSION})" unless total.zero?
queries.transaction { |tx| tx.create_major_article(title: 'kept') }
raise 'transaction did not commit' unless queries.count_major_articles.total == 1
RUBY
)
assert status.success?, "rubyVersion 3 runtime failed:\n#{stdout}\n#{stderr}"
end
def assert_pg_runtime(generated_dir)
params = {
dbname: ENV.fetch('DB_NAME'), host: ENV.fetch('POSTGRES_HOST'),
user: ENV.fetch('DB_USER'), password: ENV.fetch('DB_PASS'), port: ENV['POSTGRES_PORT']
}.compact
conn = PG.connect(**params)
conn.exec(File.read(File.join(OPTIONS_DIR, 'pg_schema.sql')))
conn.exec("INSERT INTO options_audit.option_items VALUES (1, 'note', 'tag', 'extra') ON CONFLICT (id) DO UPDATE SET note = EXCLUDED.note")
queries_path = File.join(generated_dir, 'first_sql.rb')
require queries_path
pool = ConnectionPool.new(size: 1) { PG.connect(**params) }
row = Options::PgDb::FirstSql.new(pool).get_pg_option_author(id: 1)
assert_equal [1, 'note', 'tag', 'extra'], [row.id, row.memo, row.tag, row.extra]
require File.join(OUTPUT_DIR, 'pg_first/first_sql.rb')
require File.join(OUTPUT_DIR, 'pg_second/first_sql.rb')
first = Options::PgFirst::FirstSql.new(pool)
second = Options::PgSecond::FirstSql.new(pool)
2.times do
assert_equal 1, first.get_pg_option_author(id: 1).id
assert_equal 'second module', second.get_pg_option_author(id: 1).label
end
long = 'Options::PgLongModuleNameThatPushesStatementNamesPastTheLimit'
[%w[pg_v2 pg_nested_v2 Options::PgV2 Options::Pg::V2], ['pg_long_a', 'pg_long_b', "#{long}A", "#{long}B"]]
.each do |first_dir, second_dir, first_module, second_module|
require File.join(OUTPUT_DIR, first_dir, 'first_sql.rb')
require File.join(OUTPUT_DIR, second_dir, 'first_sql.rb')
first = Object.const_get("#{first_module}::FirstSql").new(pool)
second = Object.const_get("#{second_module}::FirstSql").new(pool)
2.times do
assert_equal 1, first.get_pg_option_author(id: 1).id, first_module
assert_equal 'second module', second.get_pg_option_author(id: 1).label, second_module
end
end
ensure
pool&.shutdown(&:close)
conn&.exec('DROP SCHEMA IF EXISTS options_audit CASCADE')
conn&.close
end
end