discourse/migrations/lib/cli/convert_command.rb
Gerhard Schlager 58558849ac
DEV: Add options to run only or skip some steps in converter and importer (#35127)
Examples:

* Run only the "badges" and "users" steps in the converter:
  ```
  migrations/bin/cli convert discourse --reset --only=badges,users
  ```

* Run all steps except "users" in the converter:
  ```
  migrations/bin/cli convert discourse --reset --skip=users
  ```

* Run only the "badges" step in importer:
   This also runs all steps that "badges" depends on (e.g. "users" and "uploads").
  ```
  migrations/bin/cli import --reset --only=badges
  ```

* Run only the "badges" step in importer and skip the "users" on which "badges" depends:
  ```
  migrations/bin/cli import --reset --only=badges --skip=users
  ```
2025-10-03 16:44:36 +02:00

48 lines
1.4 KiB
Ruby

# frozen_string_literal: true
module Migrations::CLI
class ConvertCommand
def initialize(converter_type, options)
@converter_type = converter_type.downcase
@options = options
end
def execute
validate_converter_type!
settings = load_settings
::Migrations::Database.reset!(settings[:intermediate_db][:path]) if @options[:reset]
converter = "migrations/converters/#{@converter_type}/converter".camelize.constantize
converter.new(settings).run(only_steps: @options[:only], skip_steps: @options[:skip])
end
private
def validate_converter_type!
converter_names = ::Migrations::Converters.names
raise Thor::Error, <<~MSG if !converter_names.include?(@converter_type)
Unknown converter name: #{@converter_type}
Valid names are: #{converter_names.join(", ")}
MSG
end
def validate_settings_path!(settings_path)
raise Thor::Error, "Settings file not found: #{settings_path}" if !File.exist?(settings_path)
end
def load_settings
settings_path = calculate_settings_path
validate_settings_path!(settings_path)
YAML.safe_load(File.read(settings_path), symbolize_names: true)
end
def calculate_settings_path
settings_path =
@options[:settings] || ::Migrations::Converters.default_settings_path(@converter_type)
File.expand_path(settings_path, Dir.pwd)
end
end
end