catstodon/spec/lib/mastodon/cli/accounts_spec.rb

1605 lines
57 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
require 'rails_helper'
require 'mastodon/cli/accounts'
describe Mastodon::CLI::Accounts do
let(:cli) { described_class.new }
it_behaves_like 'CLI Command'
2023-10-17 15:30:12 +02:00
# `parallelize_with_progress` cannot run in transactions, so instead,
# stub it with an alternative implementation that runs sequentially
# and can run in transactions.
def stub_parallelize_with_progress!
allow(cli).to receive(:parallelize_with_progress) do |scope, &block|
aggregate = 0
total = 0
scope.reorder(nil).find_each do |record|
value = block.call(record)
aggregate += value if value.is_a?(Integer)
total += 1
end
[total, aggregate]
end
end
describe '#create' do
shared_examples 'a new user with given email address and username' do
it 'creates a new user with the specified email address' do
cli.invoke(:create, arguments, options)
expect(User.find_by(email: options[:email])).to be_present
end
it 'creates a new local account with the specified username' do
cli.invoke(:create, arguments, options)
expect(Account.find_local('tootctl_username')).to be_present
end
it 'returns "OK" and newly generated password' do
allow(SecureRandom).to receive(:hex).and_return('test_password')
expect { cli.invoke(:create, arguments, options) }.to output(
a_string_including("OK\nNew password: test_password")
).to_stdout
end
end
context 'when required USERNAME and --email are provided' do
let(:arguments) { ['tootctl_username'] }
context 'with USERNAME and --email only' do
let(:options) { { email: 'tootctl@example.com' } }
it_behaves_like 'a new user with given email address and username'
context 'with invalid --email value' do
let(:options) { { email: 'invalid' } }
it 'exits with an error message' do
expect { cli.invoke(:create, arguments, options) }.to output(
a_string_including('Failure/Error: email')
).to_stdout
.and raise_error(SystemExit)
end
end
end
context 'with --confirmed option' do
let(:options) { { email: 'tootctl@example.com', confirmed: true } }
it_behaves_like 'a new user with given email address and username'
it 'creates a new user with confirmed status' do
cli.invoke(:create, arguments, options)
user = User.find_by(email: options[:email])
expect(user.confirmed?).to be(true)
end
end
context 'with --approve option' do
let(:options) { { email: 'tootctl@example.com', approve: true } }
before do
Form::AdminSettings.new(registrations_mode: 'approved').save
end
it_behaves_like 'a new user with given email address and username'
it 'creates a new user with approved status' do
cli.invoke(:create, arguments, options)
user = User.find_by(email: options[:email])
expect(user.approved?).to be(true)
end
end
context 'with --role option' do
context 'when role exists' do
let(:default_role) { Fabricate(:user_role) }
let(:options) { { email: 'tootctl@example.com', role: default_role.name } }
it_behaves_like 'a new user with given email address and username'
it 'creates a new user and assigns the specified role' do
cli.invoke(:create, arguments, options)
role = User.find_by(email: options[:email])&.role
expect(role.name).to eq(default_role.name)
end
end
context 'when role does not exist' do
let(:options) { { email: 'tootctl@example.com', role: '404' } }
it 'exits with an error message indicating the role name was not found' do
expect { cli.invoke(:create, arguments, options) }.to output(
a_string_including('Cannot find user role with that name')
).to_stdout
.and raise_error(SystemExit)
end
end
end
context 'with --reattach option' do
context "when account's user is present" do
let(:options) { { email: 'tootctl_new@example.com', reattach: true } }
let(:user) { Fabricate.build(:user, email: 'tootctl@example.com') }
before do
Fabricate(:account, username: 'tootctl_username', user: user)
end
it 'returns an error message indicating the username is already taken' do
expect { cli.invoke(:create, arguments, options) }.to output(
a_string_including("The chosen username is currently in use\nUse --force to reattach it anyway and delete the other user")
).to_stdout
end
context 'with --force option' do
let(:options) { { email: 'tootctl_new@example.com', reattach: true, force: true } }
it 'reattaches the account to the new user and deletes the previous user' do
cli.invoke(:create, arguments, options)
user = Account.find_local('tootctl_username')&.user
expect(user.email).to eq(options[:email])
end
end
end
context "when account's user is not present" do
let(:options) { { email: 'tootctl@example.com', reattach: true } }
before do
Fabricate(:account, username: 'tootctl_username', user: nil)
end
it_behaves_like 'a new user with given email address and username'
end
end
end
context 'when required --email option is not provided' do
let(:arguments) { ['tootctl_username'] }
it 'raises a required argument missing error (Thor::RequiredArgumentMissingError)' do
expect { cli.invoke(:create, arguments) }
.to raise_error(Thor::RequiredArgumentMissingError)
end
end
end
describe '#modify' do
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating the user was not found' do
expect { cli.invoke(:modify, arguments) }.to output(
a_string_including('No user with such username')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is found' do
let(:user) { Fabricate(:user) }
let(:arguments) { [user.account.username] }
context 'when no option is provided' do
it 'returns a successful message' do
expect { cli.invoke(:modify, arguments) }.to output(
a_string_including('OK')
).to_stdout
end
it 'does not modify the user' do
cli.invoke(:modify, arguments)
expect(user).to eq(user.reload)
end
end
context 'with --role option' do
context 'when the given role is not found' do
let(:options) { { role: '404' } }
it 'exits with an error message indicating the role was not found' do
expect { cli.invoke(:modify, arguments, options) }.to output(
a_string_including('Cannot find user role with that name')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given role is found' do
let(:default_role) { Fabricate(:user_role) }
let(:options) { { role: default_role.name } }
it "updates the user's role to the specified role" do
cli.invoke(:modify, arguments, options)
role = user.reload.role
expect(role.name).to eq(default_role.name)
end
end
end
context 'with --remove-role option' do
let(:options) { { remove_role: true } }
let(:role) { Fabricate(:user_role) }
let(:user) { Fabricate(:user, role: role) }
it "removes the user's role successfully" do
cli.invoke(:modify, arguments, options)
role = user.reload.role
expect(role.name).to be_empty
end
end
context 'with --email option' do
let(:user) { Fabricate(:user, email: 'old_email@email.com') }
let(:options) { { email: 'new_email@email.com' } }
it "sets the user's unconfirmed email to the provided email address" do
cli.invoke(:modify, arguments, options)
expect(user.reload.unconfirmed_email).to eq(options[:email])
end
it "does not update the user's original email address" do
cli.invoke(:modify, arguments, options)
expect(user.reload.email).to eq('old_email@email.com')
end
context 'with --confirm option' do
let(:user) { Fabricate(:user, email: 'old_email@email.com', confirmed_at: nil) }
let(:options) { { email: 'new_email@email.com', confirm: true } }
it "updates the user's email address to the provided email" do
cli.invoke(:modify, arguments, options)
expect(user.reload.email).to eq(options[:email])
end
it "sets the user's email address as confirmed" do
cli.invoke(:modify, arguments, options)
expect(user.reload.confirmed?).to be(true)
end
end
end
context 'with --confirm option' do
let(:user) { Fabricate(:user, confirmed_at: nil) }
let(:options) { { confirm: true } }
it "confirms the user's email address" do
cli.invoke(:modify, arguments, options)
expect(user.reload.confirmed?).to be(true)
end
end
context 'with --approve option' do
let(:user) { Fabricate(:user, approved: false) }
let(:options) { { approve: true } }
before do
Form::AdminSettings.new(registrations_mode: 'approved').save
end
it 'approves the user' do
expect { cli.invoke(:modify, arguments, options) }.to change { user.reload.approved }.from(false).to(true)
end
end
context 'with --disable option' do
let(:user) { Fabricate(:user, disabled: false) }
let(:options) { { disable: true } }
it 'disables the user' do
expect { cli.invoke(:modify, arguments, options) }.to change { user.reload.disabled }.from(false).to(true)
end
end
context 'with --enable option' do
let(:user) { Fabricate(:user, disabled: true) }
let(:options) { { enable: true } }
it 'enables the user' do
expect { cli.invoke(:modify, arguments, options) }.to change { user.reload.disabled }.from(true).to(false)
end
end
context 'with --reset-password option' do
let(:options) { { reset_password: true } }
it 'returns a new password for the user' do
allow(SecureRandom).to receive(:hex).and_return('new_password')
expect { cli.invoke(:modify, arguments, options) }.to output(
a_string_including('new_password')
).to_stdout
end
end
context 'with --disable-2fa option' do
let(:user) { Fabricate(:user, otp_required_for_login: true) }
let(:options) { { disable_2fa: true } }
it 'disables the two-factor authentication for the user' do
expect { cli.invoke(:modify, arguments, options) }.to change { user.reload.otp_required_for_login }.from(true).to(false)
end
end
context 'when provided data is invalid' do
let(:user) { Fabricate(:user) }
let(:options) { { email: 'invalid' } }
it 'exits with an error message' do
expect { cli.invoke(:modify, arguments, options) }.to output(
a_string_including('Failure/Error: email')
).to_stdout
.and raise_error(SystemExit)
end
end
end
end
describe '#delete' do
let(:account) { Fabricate(:account) }
let(:arguments) { [account.username] }
let(:options) { { email: account.user.email } }
let(:delete_account_service) { instance_double(DeleteAccountService) }
before do
allow(DeleteAccountService).to receive(:new).and_return(delete_account_service)
allow(delete_account_service).to receive(:call)
end
context 'when both username and --email are provided' do
it 'exits with an error message indicating that only one should be used' do
expect { cli.invoke(:delete, arguments, options) }.to output(
a_string_including('Use username or --email, not both')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when neither username nor --email are provided' do
it 'exits with an error message indicating that no username was provided' do
expect { cli.invoke(:delete) }.to output(
a_string_including('No username provided')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when username is provided' do
it 'deletes the specified user successfully' do
cli.invoke(:delete, arguments)
expect(delete_account_service).to have_received(:call).with(account, reserve_email: false).once
end
context 'with --dry-run option' do
let(:options) { { dry_run: true } }
it 'does not delete the specified user' do
cli.invoke(:delete, arguments, options)
expect(delete_account_service).to_not have_received(:call).with(account, reserve_email: false)
end
it 'outputs a successful message in dry run mode' do
expect { cli.invoke(:delete, arguments, options) }.to output(
a_string_including('OK (DRY RUN)')
).to_stdout
end
end
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that no user was found' do
expect { cli.invoke(:delete, arguments) }.to output(
a_string_including('No user with such username')
).to_stdout
.and raise_error(SystemExit)
end
end
end
context 'when --email is provided' do
it 'deletes the specified user successfully' do
cli.invoke(:delete, nil, options)
expect(delete_account_service).to have_received(:call).with(account, reserve_email: false).once
end
context 'with --dry-run option' do
let(:options) { { email: account.user.email, dry_run: true } }
it 'does not delete the user' do
cli.invoke(:delete, nil, options)
expect(delete_account_service).to_not have_received(:call).with(account, reserve_email: false)
end
it 'outputs a successful message in dry run mode' do
expect { cli.invoke(:delete, nil, options) }.to output(
a_string_including('OK (DRY RUN)')
).to_stdout
end
end
context 'when the given email address is not found' do
let(:options) { { email: '404@example.com' } }
it 'exits with an error message indicating that no user was found' do
expect { cli.invoke(:delete, nil, options) }.to output(
a_string_including('No user with such email')
).to_stdout
.and raise_error(SystemExit)
end
end
end
end
describe '#approve' do
let(:total_users) { 4 }
before do
Form::AdminSettings.new(registrations_mode: 'approved').save
Fabricate.times(total_users, :user)
end
context 'with --all option' do
it 'approves all pending registrations' do
cli.invoke(:approve, nil, all: true)
expect(User.pluck(:approved).all?(true)).to be(true)
end
end
context 'with --number option' do
context 'when the number is positive' do
let(:options) { { number: 2 } }
it 'approves the earliest n pending registrations' do
cli.invoke(:approve, nil, options)
n_earliest_pending_registrations = User.order(created_at: :asc).first(options[:number])
expect(n_earliest_pending_registrations.all?(&:approved?)).to be(true)
end
it 'does not approve the remaining pending registrations' do
cli.invoke(:approve, nil, options)
pending_registrations = User.order(created_at: :asc).last(total_users - options[:number])
expect(pending_registrations.all?(&:approved?)).to be(false)
end
end
context 'when the number is negative' do
it 'exits with an error message indicating that the number must be positive' do
expect { cli.invoke(:approve, nil, number: -1) }.to output(
a_string_including('Number must be positive')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given number is greater than the number of users' do
let(:options) { { number: total_users * 2 } }
it 'approves all users' do
cli.invoke(:approve, nil, options)
expect(User.pluck(:approved).all?(true)).to be(true)
end
it 'does not raise any error' do
expect { cli.invoke(:approve, nil, options) }
.to_not raise_error
end
end
end
context 'with username argument' do
context 'when the given username is found' do
let(:user) { User.last }
let(:arguments) { [user.account.username] }
it 'approves the specified user successfully' do
cli.invoke(:approve, arguments)
expect(user.reload.approved?).to be(true)
end
end
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that no such account was found' do
expect { cli.invoke(:approve, arguments) }.to output(
a_string_including('No such account')
).to_stdout
.and raise_error(SystemExit)
end
end
end
end
describe '#follow' do
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that no account with the given username was found' do
expect { cli.invoke(:follow, arguments) }.to output(
a_string_including('No such account')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is found' do
let!(:target_account) { Fabricate(:account) }
let!(:follower_bob) { Fabricate(:account, username: 'bob') }
let!(:follower_rony) { Fabricate(:account, username: 'rony') }
let!(:follower_charles) { Fabricate(:account, username: 'charles') }
let(:follow_service) { instance_double(FollowService, call: nil) }
before do
allow(FollowService).to receive(:new).and_return(follow_service)
2023-10-17 15:30:12 +02:00
stub_parallelize_with_progress!
end
it 'makes all local accounts follow the target account' do
cli.follow(target_account.username)
expect(follow_service).to have_received(:call).with(follower_bob, target_account, any_args).once
expect(follow_service).to have_received(:call).with(follower_rony, target_account, any_args).once
expect(follow_service).to have_received(:call).with(follower_charles, target_account, any_args).once
end
it 'displays a successful message' do
expect { cli.follow(target_account.username) }.to output(
2023-10-17 15:30:12 +02:00
a_string_including("OK, followed target from #{Account.local.count} accounts")
).to_stdout
end
end
end
describe '#unfollow' do
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that no account with the given username was found' do
expect { cli.invoke(:unfollow, arguments) }.to output(
a_string_including('No such account')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is found' do
let!(:target_account) { Fabricate(:account) }
2023-10-17 15:30:12 +02:00
let!(:follower_chris) { Fabricate(:account, username: 'chris', domain: nil) }
let!(:follower_rambo) { Fabricate(:account, username: 'rambo', domain: nil) }
let!(:follower_ana) { Fabricate(:account, username: 'ana', domain: nil) }
let(:unfollow_service) { instance_double(UnfollowService, call: nil) }
before do
accounts = [follower_chris, follower_rambo, follower_ana]
2023-10-17 15:30:12 +02:00
accounts.each { |account| account.follow!(target_account) }
allow(UnfollowService).to receive(:new).and_return(unfollow_service)
2023-10-17 15:30:12 +02:00
stub_parallelize_with_progress!
end
it 'makes all local accounts unfollow the target account' do
cli.unfollow(target_account.username)
expect(unfollow_service).to have_received(:call).with(follower_chris, target_account).once
expect(unfollow_service).to have_received(:call).with(follower_rambo, target_account).once
expect(unfollow_service).to have_received(:call).with(follower_ana, target_account).once
end
it 'displays a successful message' do
expect { cli.unfollow(target_account.username) }.to output(
a_string_including('OK, unfollowed target from 3 accounts')
).to_stdout
end
end
end
describe '#backup' do
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that there is no such account' do
expect { cli.invoke(:backup, arguments) }.to output(
a_string_including('No user with such username')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is found' do
let(:account) { Fabricate(:account) }
let(:user) { account.user }
let(:arguments) { [account.username] }
it 'creates a new backup for the specified user' do
expect { cli.invoke(:backup, arguments) }.to change { user.backups.count }.by(1)
end
it 'creates a backup job' do
allow(BackupWorker).to receive(:perform_async)
cli.invoke(:backup, arguments)
latest_backup = user.backups.last
expect(BackupWorker).to have_received(:perform_async).with(latest_backup.id).once
end
it 'displays a successful message' do
expect { cli.invoke(:backup, arguments) }.to output(
a_string_including('OK')
).to_stdout
end
end
end
describe '#refresh' do
context 'with --all option' do
let!(:local_account) { Fabricate(:account, domain: nil) }
let!(:remote_account_example_com) { Fabricate(:account, domain: 'example.com') }
let!(:account_example_net) { Fabricate(:account, domain: 'example.net') }
let(:scope) { Account.remote }
before do
2023-10-17 15:30:12 +02:00
# TODO: we should be using `stub_parallelize_with_progress!` but
# this makes the assertions harder to write
allow(cli).to receive(:parallelize_with_progress).and_yield(remote_account_example_com)
.and_yield(account_example_net)
.and_return([2, nil])
cli.options = { all: true }
end
it 'refreshes the avatar for all remote accounts' do
allow(remote_account_example_com).to receive(:reset_avatar!)
allow(account_example_net).to receive(:reset_avatar!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(remote_account_example_com).to have_received(:reset_avatar!).once
expect(account_example_net).to have_received(:reset_avatar!).once
end
it 'does not refresh avatar for local accounts' do
allow(local_account).to receive(:reset_avatar!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(local_account).to_not have_received(:reset_avatar!)
end
it 'refreshes the header for all remote accounts' do
allow(remote_account_example_com).to receive(:reset_header!)
allow(account_example_net).to receive(:reset_header!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(remote_account_example_com).to have_received(:reset_header!).once
expect(account_example_net).to have_received(:reset_header!).once
end
it 'does not refresh the header for local accounts' do
allow(local_account).to receive(:reset_header!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(local_account).to_not have_received(:reset_header!)
end
it 'displays a successful message' do
expect { cli.refresh }.to output(
a_string_including('Refreshed 2 accounts')
).to_stdout
end
context 'with --dry-run option' do
before do
cli.options = { all: true, dry_run: true }
end
it 'does not refresh the avatar for any account' do
allow(local_account).to receive(:reset_avatar!)
allow(remote_account_example_com).to receive(:reset_avatar!)
allow(account_example_net).to receive(:reset_avatar!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(local_account).to_not have_received(:reset_avatar!)
expect(remote_account_example_com).to_not have_received(:reset_avatar!)
expect(account_example_net).to_not have_received(:reset_avatar!)
end
it 'does not refresh the header for any account' do
allow(local_account).to receive(:reset_header!)
allow(remote_account_example_com).to receive(:reset_header!)
allow(account_example_net).to receive(:reset_header!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(local_account).to_not have_received(:reset_header!)
expect(remote_account_example_com).to_not have_received(:reset_header!)
expect(account_example_net).to_not have_received(:reset_header!)
end
it 'displays a successful message with (DRY RUN)' do
expect { cli.refresh }.to output(
a_string_including('Refreshed 2 accounts (DRY RUN)')
).to_stdout
end
end
end
context 'with a list of accts' do
let!(:account_example_com_a) { Fabricate(:account, domain: 'example.com') }
let!(:account_example_com_b) { Fabricate(:account, domain: 'example.com') }
let!(:account_example_net) { Fabricate(:account, domain: 'example.net') }
let(:arguments) { [account_example_com_a.acct, account_example_com_b.acct] }
before do
# NOTE: `Account.find_remote` is stubbed so that `Account#reset_avatar!`
# can be stubbed on the individual accounts.
allow(Account).to receive(:find_remote).with(account_example_com_a.username, account_example_com_a.domain).and_return(account_example_com_a)
allow(Account).to receive(:find_remote).with(account_example_com_b.username, account_example_com_b.domain).and_return(account_example_com_b)
allow(Account).to receive(:find_remote).with(account_example_net.username, account_example_net.domain).and_return(account_example_net)
end
it 'resets the avatar for the specified accounts' do
allow(account_example_com_a).to receive(:reset_avatar!)
allow(account_example_com_b).to receive(:reset_avatar!)
cli.refresh(*arguments)
expect(account_example_com_a).to have_received(:reset_avatar!).once
expect(account_example_com_b).to have_received(:reset_avatar!).once
end
it 'does not reset the avatar for unspecified accounts' do
allow(account_example_net).to receive(:reset_avatar!)
cli.refresh(*arguments)
expect(account_example_net).to_not have_received(:reset_avatar!)
end
it 'resets the header for the specified accounts' do
allow(account_example_com_a).to receive(:reset_header!)
allow(account_example_com_b).to receive(:reset_header!)
cli.refresh(*arguments)
expect(account_example_com_a).to have_received(:reset_header!).once
expect(account_example_com_b).to have_received(:reset_header!).once
end
it 'does not reset the header for unspecified accounts' do
allow(account_example_net).to receive(:reset_header!)
cli.refresh(*arguments)
expect(account_example_net).to_not have_received(:reset_header!)
end
context 'when an UnexpectedResponseError is raised' do
it 'displays a failure message' do
allow(account_example_com_a).to receive(:reset_avatar!).and_raise(Mastodon::UnexpectedResponseError)
expect { cli.refresh(*arguments) }
.to output(
a_string_including("Account failed: #{account_example_com_a.username}@#{account_example_com_a.domain}")
).to_stdout
end
end
context 'when a specified account is not found' do
it 'exits with an error message' do
allow(Account).to receive(:find_remote).with(account_example_com_b.username, account_example_com_b.domain).and_return(nil)
expect { cli.refresh(*arguments) }.to output(
a_string_including('No such account')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'with --dry-run option' do
before do
cli.options = { dry_run: true }
end
it 'does not refresh the avatar for any account' do
allow(account_example_com_a).to receive(:reset_avatar!)
allow(account_example_com_b).to receive(:reset_avatar!)
cli.refresh(*arguments)
expect(account_example_com_a).to_not have_received(:reset_avatar!)
expect(account_example_com_b).to_not have_received(:reset_avatar!)
end
it 'does not refresh the header for any account' do
allow(account_example_com_a).to receive(:reset_header!)
allow(account_example_com_b).to receive(:reset_header!)
cli.refresh(*arguments)
expect(account_example_com_a).to_not have_received(:reset_header!)
expect(account_example_com_b).to_not have_received(:reset_header!)
end
end
end
context 'with --domain option' do
let!(:account_example_com_a) { Fabricate(:account, domain: 'example.com') }
let!(:account_example_com_b) { Fabricate(:account, domain: 'example.com') }
let!(:account_example_net) { Fabricate(:account, domain: 'example.net') }
let(:domain) { 'example.com' }
let(:scope) { Account.remote.where(domain: domain) }
before do
allow(cli).to receive(:parallelize_with_progress).and_yield(account_example_com_a)
.and_yield(account_example_com_b)
.and_return([2, nil])
cli.options = { domain: domain }
end
it 'refreshes the avatar for all accounts on specified domain' do
allow(account_example_com_a).to receive(:reset_avatar!)
allow(account_example_com_b).to receive(:reset_avatar!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(account_example_com_a).to have_received(:reset_avatar!).once
expect(account_example_com_b).to have_received(:reset_avatar!).once
end
it 'does not refresh the avatar for accounts outside specified domain' do
allow(account_example_net).to receive(:reset_avatar!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(account_example_net).to_not have_received(:reset_avatar!)
end
it 'refreshes the header for all accounts on specified domain' do
allow(account_example_com_a).to receive(:reset_header!)
allow(account_example_com_b).to receive(:reset_header!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope)
expect(account_example_com_a).to have_received(:reset_header!).once
expect(account_example_com_b).to have_received(:reset_header!).once
end
it 'does not refresh the header for accounts outside specified domain' do
allow(account_example_net).to receive(:reset_header!)
cli.refresh
expect(cli).to have_received(:parallelize_with_progress).with(scope).once
expect(account_example_net).to_not have_received(:reset_header!)
end
end
context 'when neither a list of accts nor options are provided' do
it 'exits with an error message' do
expect { cli.refresh }.to output(
a_string_including('No account(s) given')
).to_stdout
.and raise_error(SystemExit)
end
end
end
describe '#rotate' do
context 'when neither username nor --all option are given' do
it 'exits with an error message' do
expect { cli.rotate }.to output(
a_string_including('No account(s) given')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when a username is given' do
let(:account) { Fabricate(:account) }
it 'correctly rotates keys for the specified account' do
old_private_key = account.private_key
old_public_key = account.public_key
cli.rotate(account.username)
account.reload
expect(account.private_key).to_not eq(old_private_key)
expect(account.public_key).to_not eq(old_public_key)
end
it 'broadcasts the new keys for the specified account' do
allow(ActivityPub::UpdateDistributionWorker).to receive(:perform_in)
cli.rotate(account.username)
expect(ActivityPub::UpdateDistributionWorker).to have_received(:perform_in).with(anything, account.id, anything).once
end
context 'when the given username is not found' do
it 'exits with an error message when the specified username is not found' do
expect { cli.rotate('non_existent_username') }.to output(
a_string_including('No such account')
).to_stdout
.and raise_error(SystemExit)
end
end
end
context 'when --all option is provided' do
let!(:accounts) { Fabricate.times(2, :account) }
let(:options) { { all: true } }
before do
cli.options = { all: true }
end
it 'correctly rotates keys for all local accounts' do
old_private_keys = accounts.map(&:private_key)
old_public_keys = accounts.map(&:public_key)
cli.rotate
accounts.each(&:reload)
expect(accounts.map(&:private_key)).to_not eq(old_private_keys)
expect(accounts.map(&:public_key)).to_not eq(old_public_keys)
end
it 'broadcasts the new keys for each account' do
allow(ActivityPub::UpdateDistributionWorker).to receive(:perform_in)
cli.rotate
accounts.each do |account|
expect(ActivityPub::UpdateDistributionWorker).to have_received(:perform_in).with(anything, account.id, anything).once
end
end
end
end
describe '#merge' do
shared_examples 'an account not found' do |acct|
it 'exits with an error message indicating that there is no such account' do
expect { cli.invoke(:merge, arguments) }.to output(
a_string_including("No such account (#{acct})")
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when "from_account" is not found' do
let(:to_account) { Fabricate(:account, domain: 'example.com') }
let(:arguments) { ['non_existent_username@domain.com', "#{to_account.username}@#{to_account.domain}"] }
it_behaves_like 'an account not found', 'non_existent_username@domain.com'
end
context 'when "from_account" is a local account' do
let(:from_account) { Fabricate(:account, domain: nil, username: 'bob') }
let(:to_account) { Fabricate(:account, domain: 'example.com') }
let(:arguments) { [from_account.username, "#{to_account.username}@#{to_account.domain}"] }
it_behaves_like 'an account not found', 'bob'
end
context 'when "to_account" is not found' do
let(:from_account) { Fabricate(:account, domain: 'example.com') }
let(:arguments) { ["#{from_account.username}@#{from_account.domain}", 'non_existent_username'] }
it_behaves_like 'an account not found', 'non_existent_username'
end
context 'when "to_account" is local' do
let(:from_account) { Fabricate(:account, domain: 'example.com') }
let(:to_account) { Fabricate(:account, domain: nil, username: 'bob') }
let(:arguments) do
["#{from_account.username}@#{from_account.domain}", "#{to_account.username}@#{to_account.domain}"]
end
it_behaves_like 'an account not found', 'bob@'
end
context 'when "from_account" and "to_account" public keys do not match' do
let(:from_account) { instance_double(Account, username: 'bob', domain: 'example1.com', local?: false, public_key: 'from_account') }
let(:to_account) { instance_double(Account, username: 'bob', domain: 'example2.com', local?: false, public_key: 'to_account') }
let(:arguments) do
["#{from_account.username}@#{from_account.domain}", "#{to_account.username}@#{to_account.domain}"]
end
before do
allow(Account).to receive(:find_remote).with(from_account.username, from_account.domain).and_return(from_account)
allow(Account).to receive(:find_remote).with(to_account.username, to_account.domain).and_return(to_account)
end
it 'exits with an error message indicating that the accounts do not have the same pub key' do
expect { cli.invoke(:merge, arguments) }.to output(
a_string_including("Accounts don't have the same public key, might not be duplicates!\nOverride with --force")
).to_stdout
.and raise_error(SystemExit)
end
context 'with --force option' do
let(:options) { { force: true } }
before do
allow(to_account).to receive(:merge_with!)
allow(from_account).to receive(:destroy)
end
it 'merges "from_account" into "to_account"' do
cli.invoke(:merge, arguments, options)
expect(to_account).to have_received(:merge_with!).with(from_account).once
end
it 'deletes "from_account"' do
cli.invoke(:merge, arguments, options)
expect(from_account).to have_received(:destroy).once
end
end
end
context 'when "from_account" and "to_account" public keys match' do
let(:from_account) { instance_double(Account, username: 'bob', domain: 'example1.com', local?: false, public_key: 'pub_key') }
let(:to_account) { instance_double(Account, username: 'bob', domain: 'example2.com', local?: false, public_key: 'pub_key') }
let(:arguments) do
["#{from_account.username}@#{from_account.domain}", "#{to_account.username}@#{to_account.domain}"]
end
before do
allow(Account).to receive(:find_remote).with(from_account.username, from_account.domain).and_return(from_account)
allow(Account).to receive(:find_remote).with(to_account.username, to_account.domain).and_return(to_account)
allow(to_account).to receive(:merge_with!)
allow(from_account).to receive(:destroy)
end
it 'merges "from_account" into "to_account"' do
cli.invoke(:merge, arguments)
expect(to_account).to have_received(:merge_with!).with(from_account).once
end
it 'deletes "from_account"' do
cli.invoke(:merge, arguments)
expect(from_account).to have_received(:destroy)
end
end
end
describe '#cull' do
let(:delete_account_service) { instance_double(DeleteAccountService, call: nil) }
2023-10-17 15:30:12 +02:00
let!(:tom) { Fabricate(:account, updated_at: 30.days.ago, username: 'tom', uri: 'https://example.com/users/tom', domain: 'example.com', protocol: :activitypub) }
let!(:bob) { Fabricate(:account, updated_at: 30.days.ago, last_webfingered_at: nil, username: 'bob', uri: 'https://example.org/users/bob', domain: 'example.org', protocol: :activitypub) }
let!(:gon) { Fabricate(:account, updated_at: 15.days.ago, last_webfingered_at: 15.days.ago, username: 'gon', uri: 'https://example.net/users/gon', domain: 'example.net', protocol: :activitypub) }
let!(:ana) { Fabricate(:account, username: 'ana', uri: 'https://example.com/users/ana', domain: 'example.com', protocol: :activitypub) }
let!(:tales) { Fabricate(:account, updated_at: 10.days.ago, last_webfingered_at: nil, username: 'tales', uri: 'https://example.net/users/tales', domain: 'example.net', protocol: :activitypub) }
before do
allow(DeleteAccountService).to receive(:new).and_return(delete_account_service)
end
context 'when no domain is specified' do
before do
2023-10-17 15:30:12 +02:00
stub_parallelize_with_progress!
stub_request(:head, 'https://example.org/users/bob').to_return(status: 404)
stub_request(:head, 'https://example.net/users/gon').to_return(status: 410)
stub_request(:head, 'https://example.net/users/tales').to_return(status: 200)
end
it 'deletes all inactive remote accounts that longer exist in the origin server' do
cli.cull
expect(delete_account_service).to have_received(:call).with(bob, reserve_username: false).once
expect(delete_account_service).to have_received(:call).with(gon, reserve_username: false).once
end
it 'does not delete any active remote account that still exists in the origin server' do
cli.cull
expect(delete_account_service).to_not have_received(:call).with(tom, reserve_username: false)
expect(delete_account_service).to_not have_received(:call).with(ana, reserve_username: false)
expect(delete_account_service).to_not have_received(:call).with(tales, reserve_username: false)
end
it 'touches inactive remote accounts that have not been deleted' do
2023-10-17 15:30:12 +02:00
expect { cli.cull }.to(change { tales.reload.updated_at })
end
it 'displays the summary correctly' do
expect { cli.cull }.to output(
2023-10-17 15:30:12 +02:00
a_string_including('Visited 5 accounts, removed 2')
).to_stdout
end
end
context 'when a domain is specified' do
let(:domain) { 'example.net' }
before do
2023-10-17 15:30:12 +02:00
stub_parallelize_with_progress!
stub_request(:head, 'https://example.net/users/gon').to_return(status: 410)
stub_request(:head, 'https://example.net/users/tales').to_return(status: 404)
end
it 'deletes inactive remote accounts that longer exist in the specified domain' do
cli.cull(domain)
expect(delete_account_service).to have_received(:call).with(gon, reserve_username: false).once
expect(delete_account_service).to have_received(:call).with(tales, reserve_username: false).once
end
it 'displays the summary correctly' do
2023-10-17 15:30:12 +02:00
expect { cli.cull(domain) }.to output(
a_string_including('Visited 2 accounts, removed 2')
).to_stdout
end
end
context 'when a domain is unavailable' do
shared_examples 'an unavailable domain' do
before do
2023-10-17 15:30:12 +02:00
stub_parallelize_with_progress!
stub_request(:head, 'https://example.org/users/bob').to_return(status: 200)
stub_request(:head, 'https://example.net/users/gon').to_return(status: 200)
end
it 'skips accounts from the unavailable domain' do
cli.cull
expect(delete_account_service).to_not have_received(:call).with(tales, reserve_username: false)
end
it 'displays the summary correctly' do
expect { cli.cull }.to output(
2023-10-17 15:30:12 +02:00
a_string_including("Visited 5 accounts, removed 0\nThe following domains were not available during the check:\n example.net")
).to_stdout
end
end
context 'when a connection timeout occurs' do
before do
stub_request(:head, 'https://example.net/users/tales').to_timeout
end
it_behaves_like 'an unavailable domain'
end
context 'when a connection error occurs' do
before do
stub_request(:head, 'https://example.net/users/tales').to_raise(HTTP::ConnectionError)
end
it_behaves_like 'an unavailable domain'
end
context 'when an ssl error occurs' do
before do
stub_request(:head, 'https://example.net/users/tales').to_raise(OpenSSL::SSL::SSLError)
end
it_behaves_like 'an unavailable domain'
end
context 'when a private network address error occurs' do
before do
stub_request(:head, 'https://example.net/users/tales').to_raise(Mastodon::PrivateNetworkAddressError)
end
it_behaves_like 'an unavailable domain'
end
end
end
describe '#reset_relationships' do
let(:target_account) { Fabricate(:account) }
let(:arguments) { [target_account.username] }
context 'when no option is given' do
it 'exits with an error message indicating that at least one option is required' do
expect { cli.invoke(:reset_relationships, arguments) }.to output(
a_string_including('Please specify either --follows or --followers, or both')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that there is no such account' do
expect { cli.invoke(:reset_relationships, arguments, follows: true) }.to output(
a_string_including('No such account')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is found' do
let(:total_relationships) { 3 }
let!(:accounts) { Fabricate.times(total_relationships, :account) }
context 'with --follows option' do
let(:options) { { follows: true } }
before do
accounts.each { |account| target_account.follow!(account) }
end
it 'resets all "following" relationships from the target account' do
cli.invoke(:reset_relationships, arguments, options)
expect(target_account.reload.following).to be_empty
end
it 'calls BootstrapTimelineWorker once to rebuild the timeline' do
allow(BootstrapTimelineWorker).to receive(:perform_async)
cli.invoke(:reset_relationships, arguments, options)
expect(BootstrapTimelineWorker).to have_received(:perform_async).with(target_account.id).once
end
it 'displays a successful message' do
expect { cli.invoke(:reset_relationships, arguments, options) }.to output(
a_string_including("Processed #{total_relationships} relationships")
).to_stdout
end
end
context 'with --followers option' do
let(:options) { { followers: true } }
before do
accounts.each { |account| account.follow!(target_account) }
end
it 'resets all "followers" relationships from the target account' do
cli.invoke(:reset_relationships, arguments, options)
expect(target_account.reload.followers).to be_empty
end
it 'displays a successful message' do
expect { cli.invoke(:reset_relationships, arguments, options) }.to output(
a_string_including("Processed #{total_relationships} relationships")
).to_stdout
end
end
context 'with --follows and --followers options' do
let(:options) { { followers: true, follows: true } }
before do
accounts.first(2).each { |account| account.follow!(target_account) }
accounts.last(1).each { |account| target_account.follow!(account) }
end
it 'resets all "followers" relationships from the target account' do
cli.invoke(:reset_relationships, arguments, options)
expect(target_account.reload.followers).to be_empty
end
it 'resets all "following" relationships from the target account' do
cli.invoke(:reset_relationships, arguments, options)
expect(target_account.reload.following).to be_empty
end
it 'calls BootstrapTimelineWorker once to rebuild the timeline' do
allow(BootstrapTimelineWorker).to receive(:perform_async)
cli.invoke(:reset_relationships, arguments, options)
expect(BootstrapTimelineWorker).to have_received(:perform_async).with(target_account.id).once
end
it 'displays a successful message' do
expect { cli.invoke(:reset_relationships, arguments, options) }.to output(
a_string_including("Processed #{total_relationships} relationships")
).to_stdout
end
end
end
end
describe '#prune' do
let!(:local_account) { Fabricate(:account) }
let!(:bot_account) { Fabricate(:account, bot: true, domain: 'example.com') }
let!(:group_account) { Fabricate(:account, actor_type: 'Group', domain: 'example.com') }
let!(:mentioned_account) { Fabricate(:account, domain: 'example.com') }
let!(:prunable_accounts) do
Fabricate.times(2, :account, domain: 'example.com', bot: false, suspended_at: nil, silenced_at: nil)
end
before do
Fabricate(:mention, account: mentioned_account, status: Fabricate(:status, account: Fabricate(:account)))
stub_parallelize_with_progress!
end
it 'prunes all remote accounts with no interactions with local users' do
cli.prune
prunable_account_ids = prunable_accounts.pluck(:id)
expect(Account.where(id: prunable_account_ids).count).to eq(0)
end
it 'displays a successful message' do
expect { cli.prune }.to output(
a_string_including("OK, pruned #{prunable_accounts.size} accounts")
).to_stdout
end
it 'does not prune local accounts' do
cli.prune
expect(Account.exists?(id: local_account.id)).to be(true)
end
it 'does not prune bot accounts' do
cli.prune
expect(Account.exists?(id: bot_account.id)).to be(true)
end
it 'does not prune group accounts' do
cli.prune
expect(Account.exists?(id: group_account.id)).to be(true)
end
it 'does not prune accounts that have been mentioned' do
cli.prune
expect(Account.exists?(id: mentioned_account.id)).to be true
end
context 'with --dry-run option' do
before do
cli.options = { dry_run: true }
end
it 'does not prune any account' do
cli.prune
prunable_account_ids = prunable_accounts.pluck(:id)
expect(Account.where(id: prunable_account_ids).count).to eq(prunable_accounts.size)
end
it 'displays a successful message with (DRY RUN)' do
expect { cli.prune }.to output(
a_string_including("OK, pruned #{prunable_accounts.size} accounts (DRY RUN)")
).to_stdout
end
end
end
describe '#migrate' do
let!(:source_account) { Fabricate(:account) }
let!(:target_account) { Fabricate(:account, domain: 'example.com') }
let(:arguments) { [source_account.username] }
let(:resolve_account_service) { instance_double(ResolveAccountService, call: nil) }
let(:move_service) { instance_double(MoveService, call: nil) }
before do
allow(ResolveAccountService).to receive(:new).and_return(resolve_account_service)
allow(MoveService).to receive(:new).and_return(move_service)
end
shared_examples 'a successful migration' do
it 'calls the MoveService for the last migration' do
cli.invoke(:migrate, arguments, options)
last_migration = source_account.migrations.last
expect(move_service).to have_received(:call).with(last_migration).once
end
it 'displays a successful message' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including("OK, migrated #{source_account.acct} to #{target_account.acct}")
).to_stdout
end
end
context 'when both --replay and --target options are given' do
let(:options) { { replay: true, target: "#{target_account.username}@example.com" } }
it 'exits with an error message indicating that using both options is not possible' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including('Use --replay or --target, not both')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when no option is given' do
it 'exits with an error message indicating that at least one option must be used' do
expect { cli.invoke(:migrate, arguments, {}) }.to output(
a_string_including('Use either --replay or --target')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the given username is not found' do
let(:arguments) { ['non_existent_username'] }
it 'exits with an error message indicating that there is no such account' do
expect { cli.invoke(:migrate, arguments, replay: true) }.to output(
a_string_including("No such account: #{arguments.first}")
).to_stdout
.and raise_error(SystemExit)
end
end
context 'with --replay option' do
let(:options) { { replay: true } }
context 'when the specified account has no previous migrations' do
it 'exits with an error message indicating that the given account has no previous migrations' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including('The specified account has not performed any migration')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the specified account has a previous migration' do
before do
allow(resolve_account_service).to receive(:call).with(source_account.acct, any_args).and_return(source_account)
allow(resolve_account_service).to receive(:call).with(target_account.acct, any_args).and_return(target_account)
target_account.aliases.create!(acct: source_account.acct)
source_account.migrations.create!(acct: target_account.acct)
source_account.update!(moved_to_account: target_account)
end
it_behaves_like 'a successful migration'
context 'when the specified account is redirecting to a different target account' do
before do
source_account.update!(moved_to_account: nil)
end
it 'exits with an error message' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including('The specified account is not redirecting to its last migration target. Use --force if you want to replay the migration anyway')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'with --force option' do
let(:options) { { replay: true, force: true } }
it_behaves_like 'a successful migration'
end
end
end
context 'with --target option' do
let(:options) { { target: target_account.acct } }
before do
allow(resolve_account_service).to receive(:call).with(source_account.acct, any_args).and_return(source_account)
allow(resolve_account_service).to receive(:call).with(target_account.acct, any_args).and_return(target_account)
end
context 'when the specified target account is not found' do
before do
allow(resolve_account_service).to receive(:call).with(target_account.acct).and_return(nil)
end
it 'exits with an error message indicating that there is no such account' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including("The specified target account could not be found: #{options[:target]}")
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the specified target account exists' do
before do
target_account.aliases.create!(acct: source_account.acct)
end
it 'creates a migration for the specified account with the target account' do
cli.invoke(:migrate, arguments, options)
last_migration = source_account.migrations.last
expect(last_migration.acct).to eq(target_account.acct)
end
it_behaves_like 'a successful migration'
end
context 'when the migration record is invalid' do
it 'exits with an error indicating that the validation failed' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including('Error: Validation failed')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'when the specified account is redirecting to a different target account' do
before do
source_account.update(moved_to_account: Fabricate(:account))
end
it 'exits with an error message' do
expect { cli.invoke(:migrate, arguments, options) }.to output(
a_string_including('The specified account is redirecting to a different target account. Use --force if you want to change the migration target')
).to_stdout
.and raise_error(SystemExit)
end
end
context 'with --target and --force options' do
let(:options) { { target: target_account.acct, force: true } }
before do
source_account.update(moved_to_account: Fabricate(:account))
target_account.aliases.create!(acct: source_account.acct)
end
it_behaves_like 'a successful migration'
end
end
end
end