2017-08-14 13:08:09 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-08-06 13:16:09 -04:00
|
|
|
require "generators/generators_test_helper"
|
|
|
|
require "rails/generators/rails/app/app_generator"
|
2015-04-16 17:28:40 -04:00
|
|
|
|
|
|
|
class ApiAppGeneratorTest < Rails::Generators::TestCase
|
|
|
|
include GeneratorsTestHelper
|
|
|
|
tests Rails::Generators::AppGenerator
|
|
|
|
|
2016-08-06 13:16:09 -04:00
|
|
|
arguments [destination_root, "--api"]
|
2015-04-16 17:28:40 -04:00
|
|
|
|
|
|
|
def setup
|
|
|
|
Rails.application = TestApp::Application
|
|
|
|
super
|
|
|
|
|
2018-02-22 01:26:48 -05:00
|
|
|
Kernel.silence_warnings do
|
2018-12-20 12:05:27 -05:00
|
|
|
Thor::Base.shell.attr_accessor :always_force
|
2015-04-16 17:28:40 -04:00
|
|
|
@shell = Thor::Base.shell.new
|
2018-12-20 12:05:27 -05:00
|
|
|
@shell.always_force = true
|
2015-04-16 17:28:40 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def teardown
|
|
|
|
super
|
|
|
|
Rails.application = TestApp::Application.instance
|
|
|
|
end
|
|
|
|
|
|
|
|
def test_skeleton_is_created
|
|
|
|
run_generator
|
|
|
|
|
|
|
|
default_files.each { |path| assert_file path }
|
|
|
|
skipped_files.each { |path| assert_no_file path }
|
|
|
|
end
|
|
|
|
|
|
|
|
def test_api_modified_files
|
|
|
|
run_generator
|
|
|
|
|
2017-08-12 21:37:14 -04:00
|
|
|
assert_file ".gitignore" do |content|
|
2017-08-15 03:07:41 -04:00
|
|
|
assert_no_match(/\/public\/assets/, content)
|
2017-08-12 21:37:14 -04:00
|
|
|
end
|
|
|
|
|
2015-04-16 17:28:40 -04:00
|
|
|
assert_file "Gemfile" do |content|
|
|
|
|
assert_no_match(/gem 'sass-rails'/, content)
|
2015-07-09 04:51:30 -04:00
|
|
|
assert_no_match(/gem 'web-console'/, content)
|
2017-08-12 21:37:14 -04:00
|
|
|
assert_no_match(/gem 'capybara'/, content)
|
|
|
|
assert_no_match(/gem 'selenium-webdriver'/, content)
|
2015-12-15 14:45:57 -05:00
|
|
|
assert_match(/# gem 'jbuilder'/, content)
|
2017-08-12 21:37:14 -04:00
|
|
|
assert_match(/# gem 'rack-cors'/, content)
|
2015-04-16 17:28:40 -04:00
|
|
|
end
|
2015-04-17 10:51:15 -04:00
|
|
|
|
2017-08-12 21:37:14 -04:00
|
|
|
assert_file "config/application.rb", /config\.api_only = true/
|
2015-04-16 17:28:40 -04:00
|
|
|
assert_file "app/controllers/application_controller.rb", /ActionController::API/
|
|
|
|
end
|
|
|
|
|
2016-02-02 01:36:12 -05:00
|
|
|
def test_generator_if_skip_action_cable_is_given
|
2017-08-12 21:37:14 -04:00
|
|
|
run_generator [destination_root, "--api", "--skip-action-cable"]
|
2016-02-02 01:36:12 -05:00
|
|
|
assert_file "config/application.rb", /#\s+require\s+["']action_cable\/engine["']/
|
|
|
|
assert_no_file "config/cable.yml"
|
|
|
|
assert_no_file "app/channels"
|
|
|
|
assert_file "Gemfile" do |content|
|
|
|
|
assert_no_match(/redis/, content)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-02-18 16:59:04 -05:00
|
|
|
def test_generator_if_skip_action_mailer_is_given
|
2018-02-18 16:55:03 -05:00
|
|
|
run_generator [destination_root, "--api", "--skip-action-mailer"]
|
|
|
|
assert_file "config/application.rb", /#\s+require\s+["']action_mailer\/railtie["']/
|
|
|
|
assert_file "config/environments/development.rb" do |content|
|
|
|
|
assert_no_match(/config\.action_mailer/, content)
|
|
|
|
end
|
|
|
|
assert_file "config/environments/test.rb" do |content|
|
|
|
|
assert_no_match(/config\.action_mailer/, content)
|
|
|
|
end
|
|
|
|
assert_file "config/environments/production.rb" do |content|
|
|
|
|
assert_no_match(/config\.action_mailer/, content)
|
|
|
|
end
|
|
|
|
assert_no_directory "app/mailers"
|
|
|
|
assert_no_directory "test/mailers"
|
|
|
|
assert_no_directory "app/views"
|
|
|
|
end
|
|
|
|
|
2017-03-23 19:31:30 -04:00
|
|
|
def test_app_update_does_not_generate_unnecessary_config_files
|
|
|
|
run_generator
|
|
|
|
|
|
|
|
generator = Rails::Generators::AppGenerator.new ["rails"],
|
2017-08-12 07:31:46 -04:00
|
|
|
{ api: true, update: true }, { destination_root: destination_root, shell: @shell }
|
2017-03-23 19:31:30 -04:00
|
|
|
quietly { generator.send(:update_config_files) }
|
|
|
|
|
|
|
|
assert_no_file "config/initializers/cookies_serializer.rb"
|
|
|
|
assert_no_file "config/initializers/assets.rb"
|
2017-11-27 07:46:26 -05:00
|
|
|
assert_no_file "config/initializers/content_security_policy.rb"
|
2017-03-23 19:31:30 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def test_app_update_does_not_generate_unnecessary_bin_files
|
|
|
|
run_generator
|
|
|
|
|
|
|
|
generator = Rails::Generators::AppGenerator.new ["rails"],
|
2017-08-12 07:31:46 -04:00
|
|
|
{ api: true, update: true }, { destination_root: destination_root, shell: @shell }
|
2017-03-23 19:31:30 -04:00
|
|
|
quietly { generator.send(:update_bin_files) }
|
|
|
|
|
|
|
|
assert_no_file "bin/yarn"
|
|
|
|
end
|
|
|
|
|
2015-04-16 17:28:40 -04:00
|
|
|
private
|
|
|
|
|
2016-08-06 13:55:02 -04:00
|
|
|
def default_files
|
2017-08-12 21:37:14 -04:00
|
|
|
%w(.gitignore
|
|
|
|
.ruby-version
|
|
|
|
README.md
|
2016-08-06 13:55:02 -04:00
|
|
|
Gemfile
|
|
|
|
Rakefile
|
|
|
|
config.ru
|
2017-08-12 21:37:14 -04:00
|
|
|
app/channels
|
2016-08-06 13:55:02 -04:00
|
|
|
app/controllers
|
|
|
|
app/mailers
|
|
|
|
app/models
|
2017-08-12 21:37:14 -04:00
|
|
|
app/views/layouts
|
2016-08-06 13:55:02 -04:00
|
|
|
app/views/layouts/mailer.html.erb
|
|
|
|
app/views/layouts/mailer.text.erb
|
2017-08-12 21:37:14 -04:00
|
|
|
bin/rails
|
|
|
|
bin/rake
|
|
|
|
bin/setup
|
|
|
|
bin/update
|
|
|
|
config/application.rb
|
|
|
|
config/boot.rb
|
|
|
|
config/cable.yml
|
|
|
|
config/environment.rb
|
2016-08-06 13:55:02 -04:00
|
|
|
config/environments
|
2017-08-12 21:37:14 -04:00
|
|
|
config/environments/development.rb
|
|
|
|
config/environments/production.rb
|
|
|
|
config/environments/test.rb
|
2016-08-06 13:55:02 -04:00
|
|
|
config/initializers
|
2017-08-12 21:37:14 -04:00
|
|
|
config/initializers/application_controller_renderer.rb
|
|
|
|
config/initializers/backtrace_silencers.rb
|
|
|
|
config/initializers/cors.rb
|
|
|
|
config/initializers/filter_parameter_logging.rb
|
|
|
|
config/initializers/inflections.rb
|
|
|
|
config/initializers/mime_types.rb
|
|
|
|
config/initializers/wrap_parameters.rb
|
2016-08-06 13:55:02 -04:00
|
|
|
config/locales
|
2017-08-12 21:37:14 -04:00
|
|
|
config/locales/en.yml
|
|
|
|
config/puma.rb
|
|
|
|
config/routes.rb
|
Add credentials using a generic EncryptedConfiguration class (#30067)
* WIP: Add credentials using a generic EncryptedConfiguration class
This is sketch code so far.
* Flesh out EncryptedConfiguration and test it
* Better name
* Add command and generator for credentials
* Use the Pathnames
* Extract EncryptedFile from EncryptedConfiguration and add serializers
* Test EncryptedFile
* Extract serializer validation
* Stress the point about losing comments
* Allow encrypted configuration to be read without parsing for display
* Use credentials by default and base them on the master key
* Derive secret_key_base in test/dev, source it from credentials in other envs
And document the usage.
* Document the new credentials setup
* Stop generating the secrets.yml file now that we have credentials
* Document what we should have instead
Still need to make it happen, tho.
* [ci skip] Keep wording to `key base`; prefer defaults.
Usually we say we change defaults, not "spec" out a release.
Can't use backticks in our sdoc generated documentation either.
* Abstract away OpenSSL; prefer MessageEncryptor.
* Spare needless new when raising.
* Encrypted file test shouldn't depend on subclass.
* [ci skip] Some woordings.
* Ditch serializer future coding.
* I said flip it. Flip it good.
* [ci skip] Move require_master_key to the real production.rb.
* Add require_master_key to abort the boot process.
In case the master key is required in a certain environment
we should inspect that the key is there and abort if it isn't.
* Print missing key message and exit immediately.
Spares us a lengthy backtrace and prevents further execution.
I've verified the behavior in a test app, but couldn't figure the
test out as loading the app just exits immediately with:
```
/Users/kasperhansen/Documents/code/rails/activesupport/lib/active_support/testing/isolation.rb:23:in `load': marshal data too short (ArgumentError)
from /Users/kasperhansen/Documents/code/rails/activesupport/lib/active_support/testing/isolation.rb:23:in `run'
from /Users/kasperhansen/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/minitest-5.10.2/lib/minitest.rb:830:in `run_one_method'
from /Users/kasperhansen/.rbenv/versions/2.4.1/lib/ruby/gems/2.4.0/gems/minitest-5.10.2/lib/minitest/parallel.rb:32:in `block (2 levels) in start'
```
It's likely we need to capture and prevent the exit somehow.
Kernel.stub(:exit) didn't work. Leaving it for tomorrow.
* Fix require_master_key config test.
Loading the app would trigger the `exit 1` per require_master_key's
semantics, which then aborted the test.
Fork and wait for the child process to finish, then inspect the
exit status.
Also check we aborted because of a missing master key, so something
else didn't just abort the boot.
Much <3 to @tenderlove for the tip.
* Support reading/writing configs via methods.
* Skip needless deep symbolizing.
* Remove save; test config reader elsewhere.
* Move secret_key_base check to when we're reading it.
Otherwise we'll abort too soon since we don't assign the secret_key_base
to secrets anymore.
* Add missing string literal comments; require unneeded yaml require.
* ya ya ya, rubocop.
* Add master_key/credentials after bundle.
Then we can reuse the existing message on `rails new bc4`.
It'll look like:
```
Using web-console 3.5.1 from https://github.com/rails/web-console.git (at master@ce985eb)
Using rails 5.2.0.alpha from source at `/Users/kasperhansen/Documents/code/rails`
Using sass-rails 5.0.6
Bundle complete! 16 Gemfile dependencies, 72 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Adding config/master.key to store the master encryption key: 97070158c44b4675b876373a6bc9d5a0
Save this in a password manager your team can access.
If you lose the key, no one, including you, can access anything encrypted with it.
create config/master.key
```
And that'll be executed even if `--skip-bundle` was passed.
* Ensure test app has secret_key_base.
* Assign secret_key_base to app or omit.
* Merge noise
* Split options for dynamic delegation into its own method and use deep symbols to make it work
* Update error to point to credentials instead
* Appease Rubocop
* Validate secret_key_base when reading it.
Instead of relying on the validation in key_generator move that into
secret_key_base itself.
* Fix generator and secrets test.
Manually add config.read_encrypted_secrets since it's not there by default
anymore.
Move mentions of config/secrets.yml to config/credentials.yml.enc.
* Remove files I have no idea how they got here.
* [ci skip] swap secrets for credentials.
* [ci skip] And now, changelogs are coming.
2017-09-11 14:21:20 -04:00
|
|
|
config/credentials.yml.enc
|
2017-08-12 21:37:14 -04:00
|
|
|
config/spring.rb
|
|
|
|
config/storage.yml
|
2016-08-06 13:55:02 -04:00
|
|
|
db
|
2017-08-12 21:37:14 -04:00
|
|
|
db/seeds.rb
|
2016-08-06 13:55:02 -04:00
|
|
|
lib
|
|
|
|
lib/tasks
|
|
|
|
log
|
|
|
|
test/fixtures
|
|
|
|
test/controllers
|
|
|
|
test/integration
|
|
|
|
test/models
|
|
|
|
tmp
|
|
|
|
vendor
|
|
|
|
)
|
|
|
|
end
|
2015-04-16 17:28:40 -04:00
|
|
|
|
2016-08-06 13:55:02 -04:00
|
|
|
def skipped_files
|
|
|
|
%w(app/assets
|
|
|
|
app/helpers
|
|
|
|
app/views/layouts/application.html.erb
|
2016-12-08 22:07:40 -05:00
|
|
|
bin/yarn
|
2016-08-06 13:55:02 -04:00
|
|
|
config/initializers/assets.rb
|
|
|
|
config/initializers/cookies_serializer.rb
|
2017-11-27 07:46:26 -05:00
|
|
|
config/initializers/content_security_policy.rb
|
2016-08-06 13:55:02 -04:00
|
|
|
lib/assets
|
|
|
|
test/helpers
|
|
|
|
tmp/cache/assets
|
|
|
|
public/404.html
|
|
|
|
public/422.html
|
|
|
|
public/500.html
|
|
|
|
public/apple-touch-icon-precomposed.png
|
|
|
|
public/apple-touch-icon.png
|
2017-08-12 21:37:14 -04:00
|
|
|
public/favicon.ico
|
2017-02-21 11:33:31 -05:00
|
|
|
package.json
|
2016-12-08 22:07:40 -05:00
|
|
|
)
|
2016-08-06 13:55:02 -04:00
|
|
|
end
|
2015-04-16 17:28:40 -04:00
|
|
|
end
|