A platform for community discussion. Free, open, simple.
DEV: Run S3 system specs against a MinIO CI service (#43622)
Alan Guo Xiang Tand4971434ce13
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.ymlindex 46685ebacfa..188761a1002 100644--- a/.github/workflows/tests.yml+++ b/.github/workflows/tests.yml@@ -35,6 +35,14 @@ jobs:|| 'ubuntu-latest'}}container: discourse/discourse_test:release+ services:+ minio:+ image: ${{ matrix.build_type == 'system' && matrix.target == 'core' && 'bitnami/minio@sha256:50cec18ac4184af4671a78aedd5554942c8ae105d51a465fa82037949046da01' || '' }}+ env:+ MINIO_ROOT_USER: minioadmin+ MINIO_ROOT_PASSWORD: minioadmin+ MINIO_DEFAULT_BUCKETS: discoursetest+ MINIO_DOMAIN: minio.localtimeout-minutes: >-${{matrix.build_type == 'system' && (matrix.target == 'core-plugins' || matrix.target == 'official-plugins' || matrix.target == 'core')@@ -52,11 +60,13 @@ jobs:PGPASSWORD: discourseUSES_PARALLEL_DATABASES: ${{ matrix.build_type == 'backend' || matrix.build_type == 'system' }}CAPYBARA_DEFAULT_MAX_WAIT_TIME: 20- MINIO_RUNNER_LOG_LEVEL: WARN+ S3_SYSTEM_TEST_ENDPOINT: ${{ matrix.build_type == 'system' && matrix.target == 'core' && 'http://minio.local:9000' || '' }}+ S3_SYSTEM_TEST_BUCKET: discoursetest+ S3_SYSTEM_TEST_ACCESS_KEY_ID: minioadmin+ S3_SYSTEM_TEST_SECRET_ACCESS_KEY: minioadminDISCOURSE_TURBO_RSPEC_RETRY_AND_LOG_FLAKY_TESTS: ${{ (matrix.build_type == 'system' || matrix.build_type == 'backend') && '1' }}CHEAP_SOURCE_MAPS: "1"DBUS_SESSION_BUS_ADDRESS: "unix:path=/dev/null"- MINIO_RUNNER_INSTALL_DIR: /home/discourse/.minio_runnerEMBER_ENV: developmentLOAD_PLUGINS: ${{ (matrix.target == 'core-plugins' || matrix.target == 'official-plugins' || matrix.target == 'plugins' || matrix.target == 'chat') && '1' || '0' }}QUNIT_REUSE_BUILD: 1@@ -172,8 +182,9 @@ jobs:- name: Add hosts to /etc/hosts, otherwise Chrome cannot reach minioif: matrix.build_type == 'system' && matrix.target == 'core'run: |- echo "127.0.0.1 minio.local" | sudo tee -a /etc/hosts- echo "127.0.0.1 discoursetest.minio.local" | sudo tee -a /etc/hosts+ minio_ip="$(getent ahostsv4 minio | awk 'NR == 1 { print $1 }')"+ echo "$minio_ip minio.local discoursetest.minio.local" | sudo tee -a /etc/hosts+ curl --fail --retry 10 --retry-connrefused --retry-delay 1 http://minio.local:9000/minio/health/ready- name: Create databasesrun: bin/rake db:creatediff --git a/Gemfile b/Gemfileindex 825ef35a745..fa4550d2687 100644--- a/Gemfile+++ b/Gemfile@@ -130,7 +130,6 @@ group :test dogem "simplecov", require: falsegem "test-prof", require: falsegem "rails-dom-testing", require: false- gem "minio_runner", require: falsegem "capybara-playwright-driver", require: falsegem "puma", require: falseenddiff --git a/Gemfile.lock b/Gemfile.lockindex e9f642c44d9..d23ec541ec9 100644--- a/Gemfile.lock+++ b/Gemfile.lock@@ -375,7 +375,6 @@ GEMmini_sql (1.6.0)mini_suffix (0.3.3)ffi (~> 1.9)- minio_runner (1.1.0)minitest (6.0.6)drb (~> 2.0)prism (~> 1.5)@@ -907,7 +906,6 @@ DEPENDENCIESmini_schedulermini_sqlmini_suffix- minio_runnermochamsgpackmulti_json@@ -1153,7 +1151,6 @@ CHECKSUMSmini_scheduler (0.20.0) sha256=bd8948228bf4a48a603a8e20de850d16b68295413d8651c8c05288f4c6997b05mini_sql (1.6.0) sha256=5296637f6a4af5bb43e06788037e9a2968ff9c8eb65928befcba8cb41f42d6eemini_suffix (0.3.3) sha256=8d1d33f92f69a2247c9b7d27173235da90479d955cdb863b63a7f53843b722e7- minio_runner (1.1.0) sha256=ebb2bedea253011fcd34ed3229706c9b453f0f363601dee7ce065e0163bdcf2fminitest (6.0.6) sha256=153ea36d1d987a62942382b61075745042a2b3123b1cd48f4c3675af9cc7d6f1mocha (3.1.0) sha256=75f42d69ebfb1f10b32489dff8f8431d37a418120ecdfc07afe3bc183d4e1d56msgpack (1.8.4) sha256=4411c22d350dd1c20250f7eada3cca2695438c2f769cf0782f0cd065d90a3e7bdiff --git a/script/install_minio_binaries.rb b/script/install_minio_binaries.rbdeleted file mode 100755index a40f070e866..00000000000--- a/script/install_minio_binaries.rb+++ /dev/null@@ -1,7 +0,0 @@-#!/usr/bin/env ruby-# frozen_string_literal: true--require "minio_runner"--ENV["MINIO_RUNNER_LOG_LEVEL"] = "DEBUG"-MinioRunner.install_binariesdiff --git a/script/local_minio_s3.rb b/script/local_minio_s3.rbdeleted file mode 100755index f2b5de3e2e9..00000000000--- a/script/local_minio_s3.rb+++ /dev/null@@ -1,90 +0,0 @@-#!/usr/bin/env ruby-# frozen_string_literal: true--require "minio_runner"--class ExecuteLocalMinioS3- def run- start_minio- save_old_config- change_to_minio_settings- puts "Press any key when done..."- gets- restore_old- rescue SystemExit, Interrupt- restore_old- raise- end-- def start_minio- MinioRunner.config do |minio_runner_config|- minio_runner_config.minio_domain = ENV["MINIO_RUNNER_MINIO_DOMAIN"] || "minio.local"- minio_runner_config.buckets =- (- if ENV["MINIO_RUNNER_BUCKETS"]- ENV["MINIO_RUNNER_BUCKETS"].split(",")- else- ["discoursetest"]- end- )- minio_runner_config.public_buckets =- (- if ENV["MINIO_RUNNER_PUBLIC_BUCKETS"]- ENV["MINIO_RUNNER_PUBLIC_BUCKETS"].split(",")- else- ["discoursetest"]- end- )- end- puts "Starting minio..."- MinioRunner.start- end-- def save_old_config- puts "Temporarily using minio config for S3. Current settings:"- @current_s3_endpoint = puts_current(:s3_endpoint)- @current_s3_upload_bucket = puts_current(:s3_upload_bucket)- @current_s3_access_key_id = puts_current(:s3_access_key_id)- @current_s3_secret_access_key = puts_current(:s3_secret_access_key)- @current_allowed_internal_hosts = puts_current(:allowed_internal_hosts)- end-- def change_to_minio_settings- puts "Changing to minio settings..."- SiteSetting.s3_upload_bucket = "discoursetest"- SiteSetting.s3_access_key_id = MinioRunner.config.minio_root_user- SiteSetting.s3_secret_access_key = MinioRunner.config.minio_root_password- SiteSetting.s3_endpoint = MinioRunner.config.minio_server_url- SiteSetting.allowed_internal_hosts =- MinioRunner.config.minio_urls.map { |url| URI.parse(url).host }.join("|")-- puts_current(:s3_endpoint)- puts_current(:s3_upload_bucket)- puts_current(:s3_access_key_id)- puts_current(:s3_secret_access_key)- puts_current(:allowed_internal_hosts)- end-- def restore_old- puts "Restoring old S3 settings..."- SiteSetting.s3_upload_bucket = @current_s3_upload_bucket- SiteSetting.s3_access_key_id = @current_s3_access_key_id- SiteSetting.s3_secret_access_key = @current_s3_secret_access_key- SiteSetting.s3_endpoint = @current_s3_endpoint- SiteSetting.allowed_internal_hosts = @current_allowed_internal_hosts-- puts_current(:s3_endpoint)- puts_current(:s3_upload_bucket)- puts_current(:s3_access_key_id)- puts_current(:s3_secret_access_key)- puts_current(:allowed_internal_hosts)- puts "Done!"- end-- def puts_current(setting)- printf "%-40s %s\n", " > Current #{setting}:", SiteSetting.send(setting)- SiteSetting.send(setting)- end-end--ExecuteLocalMinioS3.new.rundiff --git a/spec/rails_helper.rb b/spec/rails_helper.rbindex d51e79d5159..258bf4d40b3 100644--- a/spec/rails_helper.rb+++ b/spec/rails_helper.rb@@ -190,13 +190,17 @@ RSpec.configure do |config|# Rebase the seeded DB settings as defaults, then swap in the in-memory provider.TestLocalProcessProvider.install!+ s3_system_test_urls = []+ if ENV["S3_SYSTEM_TEST_ENDPOINT"].present?+ s3_endpoint = URI(ENV.fetch("S3_SYSTEM_TEST_ENDPOINT"))+ s3_bucket_endpoint = s3_endpoint.dup+ s3_bucket_endpoint.host = "#{ENV.fetch("S3_SYSTEM_TEST_BUCKET")}.#{s3_endpoint.host}"+ s3_system_test_urls = [s3_endpoint.to_s, s3_bucket_endpoint.to_s]+ end+WebMock.disable_net_connect!(allow_localhost: true,- allow: [- *MinioRunner.config.minio_urls,- URI(MinioRunner::MinioBinary.platform_binary_url).host,- ENV["CAPYBARA_REMOTE_DRIVER_URL"],- ].compact,+ allow: [*s3_system_test_urls, ENV["CAPYBARA_REMOTE_DRIVER_URL"]].compact,)# Registering this from inside before(:suite) makes it run at the end of thediff --git a/spec/support/minio.rb b/spec/support/minio.rbdeleted file mode 100644index cfbcb5006e6..00000000000--- a/spec/support/minio.rb+++ /dev/null@@ -1,41 +0,0 @@-# frozen_string_literal: true--# Minio (S3-compatible) server config for S3 system specs--require "minio_runner"--RSpec.configure do |config|- config.before(:suite) do- MinioRunner.config do |minio_runner_config|- minio_runner_config.minio_domain = ENV["MINIO_RUNNER_MINIO_DOMAIN"] || "minio.local"- minio_runner_config.buckets =- (- if ENV["MINIO_RUNNER_BUCKETS"]- ENV["MINIO_RUNNER_BUCKETS"].split(",")- else- ["discoursetest"]- end- )- minio_runner_config.public_buckets =- (- if ENV["MINIO_RUNNER_PUBLIC_BUCKETS"]- ENV["MINIO_RUNNER_PUBLIC_BUCKETS"].split(",")- else- ["discoursetest"]- end- )-- test_i = ENV["TEST_ENV_NUMBER"].to_i-- data_dir = "#{Rails.root.join("tmp/test_data_#{test_i}/minio")}"- FileUtils.rm_rf(data_dir)- FileUtils.mkdir_p(data_dir)- minio_runner_config.minio_data_directory = data_dir-- minio_runner_config.minio_port = 9_000 + 2 * test_i- minio_runner_config.minio_console_port = 9_001 + 2 * test_i- end- end-- config.after(:suite) { MinioRunner.stop }-enddiff --git a/spec/support/system/driver.rb b/spec/support/system/driver.rbindex 10db6a20f50..9abc69c7192 100644--- a/spec/support/system/driver.rb+++ b/spec/support/system/driver.rb@@ -137,14 +137,15 @@ module SystemDrivers# requests. Unlike Playwright request interception it leaves the HTTP cache# enabled. Rules are first-match-wins, so the excludes and the MAPs above# take precedence.- minio_domain = ENV["MINIO_RUNNER_MINIO_DOMAIN"].presence || "minio.local"resolver_rules.push("EXCLUDE localhost","EXCLUDE *.localhost","EXCLUDE #{Capybara.server_host}",- "EXCLUDE #{minio_domain}",- "EXCLUDE *.#{minio_domain}",)+ if ENV["S3_SYSTEM_TEST_ENDPOINT"].present?+ s3_system_test_domain = URI(ENV.fetch("S3_SYSTEM_TEST_ENDPOINT")).host+ resolver_rules.push("EXCLUDE #{s3_system_test_domain}", "EXCLUDE *.#{s3_system_test_domain}")+ end# Hosts a spec opted into via `allow_network:` resolve normally; everything# else falls through to NXDOMAIN.allow_network.each { |host| resolver_rules.push("EXCLUDE #{host}") }diff --git a/spec/support/system_helpers.rb b/spec/support/system_helpers.rbindex ebde802df7c..706803737f9 100644--- a/spec/support/system_helpers.rb+++ b/spec/support/system_helpers.rb@@ -77,11 +77,14 @@ module SystemHelpersSiteSetting.port = Capybara.server_portSiteSetting.external_system_avatars_url = ""SiteSetting.enable_user_tips = false- SiteSetting.allowed_internal_hosts =- (- SiteSetting.allowed_internal_hosts.to_s.split("|") +- MinioRunner.config.minio_urls.map { |url| URI.parse(url).host }- ).join("|")+ if ENV["S3_SYSTEM_TEST_ENDPOINT"].present?+ s3_host = URI(ENV.fetch("S3_SYSTEM_TEST_ENDPOINT")).host+ s3_bucket = ENV.fetch("S3_SYSTEM_TEST_BUCKET")+ SiteSetting.allowed_internal_hosts =+ (+ SiteSetting.allowed_internal_hosts.to_s.split("|") + [s3_host, "#{s3_bucket}.#{s3_host}"]+ ).join("|")+ endenddef try_until_success(timeout: Capybara.default_max_wait_time, frequency: 0.01, reason: nil)@@ -224,25 +227,36 @@ module SystemHelpersSiteSetting.enable_s3_uploads = true- SiteSetting.s3_upload_bucket = "discoursetest"+ SiteSetting.s3_upload_bucket = ENV.fetch("S3_SYSTEM_TEST_BUCKET")SiteSetting.enable_upload_debug_mode = true- SiteSetting.s3_access_key_id = MinioRunner.config.minio_root_user- SiteSetting.s3_secret_access_key = MinioRunner.config.minio_root_password- SiteSetting.s3_endpoint = MinioRunner.config.minio_server_url+ SiteSetting.s3_access_key_id = ENV.fetch("S3_SYSTEM_TEST_ACCESS_KEY_ID")+ SiteSetting.s3_secret_access_key = ENV.fetch("S3_SYSTEM_TEST_SECRET_ACCESS_KEY")+ SiteSetting.s3_endpoint = ENV.fetch("S3_SYSTEM_TEST_ENDPOINT")SiteSetting.enable_direct_s3_uploads = enable_direct_s3_uploadsSiteSetting.secure_uploads = enable_secure_uploads- # On CI, the minio binary is preinstalled in the docker image so there is no need for us to check for a new binary- MinioRunner.start(install: ENV["CI"] ? false : true)+ s3_options = S3Helper.s3_options(SiteSetting)+ Aws::S3::Client.new(**s3_options, force_path_style: true).put_bucket_policy(+ bucket: SiteSetting.s3_upload_bucket,+ policy: {+ Version: "2012-10-17",+ Statement: [+ {+ Effect: "Allow",+ Principal: "*",+ Action: "s3:GetObject",+ Resource: "arn:aws:s3:::#{SiteSetting.s3_upload_bucket}/*",+ },+ ],+ }.to_json,+ )enddef skip_unless_s3_system_specs_enabled!- if !ENV["CI"] && !ENV["RUN_S3_SYSTEM_SPECS"]- skip(- "S3 system specs are disabled in this environment, set CI=1 or RUN_S3_SYSTEM_SPECS=1 to enable them.",- )+ if ENV["S3_SYSTEM_TEST_ENDPOINT"].blank?+ skip("S3 system specs require S3_SYSTEM_TEST_ENDPOINT and its related credentials.")endend