imap-backup 4.2.0 → 5.1.0

data/spec/features/local/list_accounts_spec.rb

@@ -0,0 +1,12 @@
+require "features/helper"
+
+RSpec.describe "Listing accounts", type: :aruba do
+  before do
+    create_config(accounts: [{"username": "me@example.com"}])
+    run_command_and_stop("imap-backup local accounts")
+  end
+
+  it "lists accounts" do
+    expect(last_command_started).to have_output("me@example.com")
+  end
+end

data/spec/features/local/list_emails_spec.rb

@@ -0,0 +1,21 @@
+require "features/helper"
+
+RSpec.describe "Listing emails", type: :aruba do
+  let(:email) { "me@example.com" }
+  let(:account) do
+    {
+      username: email,
+      local_path: File.join(config_path, email.gsub("@", "_"))
+    }
+  end
+
+  before do
+    create_config(accounts: [account])
+    store_email(email: email, folder: "my_folder", subject: "Ciao")
+    run_command_and_stop("imap-backup local list #{email} my_folder")
+  end
+
+  it "lists emails" do
+    expect(last_command_started).to have_output(/1: Ciao/)
+  end
+end

data/spec/features/local/list_folders_spec.rb

@@ -0,0 +1,21 @@
+require "features/helper"
+
+RSpec.describe "Listing account folders", type: :aruba do
+  let(:email) { "me@example.com" }
+  let(:account) do
+    {
+      username: email,
+      local_path: File.join(config_path, email.gsub("@", "_"))
+    }
+  end
+
+  before do
+    create_config(accounts: [account])
+    store_email(email: email, folder: "my_folder", body: "Hi")
+    run_command_and_stop("imap-backup local folders #{email}")
+  end
+
+  it "lists folders that have been backed up" do
+    expect(last_command_started).to have_output(%q("my_folder"))
+  end
+end

data/spec/features/local/show_an_email_spec.rb

@@ -0,0 +1,34 @@
+require "features/helper"
+
+RSpec.describe "Show an email", type: :aruba do
+  let(:email) { "me@example.com" }
+  let(:account) do
+    {
+      username: email,
+      local_path: File.join(config_path, email.gsub("@", "_"))
+    }
+  end
+
+  before do
+    create_config(accounts: [account])
+    store_email(
+      email: email,
+      folder: "my_folder",
+      uid: 99,
+      from: "me@example.com",
+      subject: "Hello",
+      body: "How're things?"
+    )
+    run_command_and_stop("imap-backup local show #{email} my_folder 99")
+  end
+
+  it "shows the email" do
+    expected = <<~BODY
+      From: me@example.com
+      Subject: Hello
+      
+      How're things?
+    BODY
+    expect(last_command_started).to have_output(expected)
+  end
+end

data/spec/features/migrate_spec.rb

@@ -0,0 +1,35 @@
+require "features/helper"
+
+RSpec.describe "Migration", type: :aruba, docker: true do
+  let(:email) { "me@example.com" }
+  let(:folder) { "my_folder" }
+  let(:source_account) do
+    {
+      username: email,
+      local_path: File.join(config_path, email.gsub("@", "_"))
+    }
+  end
+  let(:destination_account) { fixture("connection") }
+
+  before do
+    create_config(accounts: [source_account, destination_account])
+    store_email(email: email, folder: folder, subject: "Ciao")
+    run_command_and_stop("imap-backup migrate #{email} #{destination_account[:username]}")
+  end
+
+  after do
+    delete_emails(folder)
+  end
+
+  it "copies email to the destination account" do
+    messages = server_messages(folder)
+    expected = <<~MESSAGE.gsub("\n", "\r\n")
+      From: sender@example.com
+      Subject: Ciao
+
+      body
+
+    MESSAGE
+    expect(messages[0]["BODY[]"]).to eq(expected)
+  end
+end

data/spec/features/remote/list_account_folders_spec.rb

@@ -0,0 +1,16 @@
+require "features/helper"
+
+RSpec.describe "List account folders", type: :aruba do
+  let(:account) do
+    fixture("connection")
+  end
+
+  before do
+    create_config(accounts: [account])
+    run_command_and_stop("imap-backup remote folders #{account[:username]}")
+  end
+
+  it "lists folders" do
+    expect(last_command_started).to have_output(/"INBOX"/)
+  end
+end

data/spec/features/restore_spec.rb

@@ -1,9 +1,11 @@
 require "features/helper"
 
-RSpec.describe "restore", type: :feature, docker: true do
+RSpec.describe "restore", type: :aruba, docker: true do
   include_context "imap-backup connection"
   include_context "message-fixtures"
 
+  let(:local_backup_path) { File.expand_path("~/backup") }
+  let(:folder) { "my-stuff" }
   let(:messages_as_mbox) do
     message_as_mbox_entry(msg1) + message_as_mbox_entry(msg2)
   end
@@ -12,19 +14,19 @@ RSpec.describe "restore", type: :feature, docker: true do
   end
   let(:message_uids) { [msg1[:uid], msg2[:uid]] }
   let(:existing_imap_content) { imap_data(uid_validity, message_uids).to_json }
-  let(:folder) { "my-stuff" }
   let(:uid_validity) { 1234 }
 
   let!(:pre) {}
   let!(:setup) do
+    create_directory local_backup_path
     File.write(imap_path(folder), existing_imap_content)
     File.write(mbox_path(folder), messages_as_mbox)
-    connection.restore
+    create_config(accounts: [account.to_h])
+
+    run_command_and_stop("imap-backup restore #{account.username}")
   end
   let(:cleanup) do
-    FileUtils.rm_rf local_backup_path
     server_delete_folder folder
-    connection.disconnect
   end
 
   after { cleanup }

data/spec/features/support/aruba.rb

@@ -0,0 +1,73 @@
+require "aruba/rspec"
+
+require_relative "backup_directory"
+
+Aruba.configure do |config|
+  config.home_directory = File.expand_path("./tmp/home")
+  config.allow_absolute_paths = true
+end
+
+module ConfigurationHelpers
+  def config_path
+    File.expand_path("~/.imap-backup")
+  end
+
+  def create_config(accounts:, debug: false)
+    pathname = File.join(config_path, "config.json")
+    save_data = {
+      version: Imap::Backup::Configuration::VERSION,
+      accounts: accounts,
+      debug: debug
+    }
+    FileUtils.mkdir_p config_path
+    File.open(pathname, "w") { |f| f.write(JSON.pretty_generate(save_data)) }
+    FileUtils.chmod(0o600, pathname)
+  end
+end
+
+module StoreHelpers
+  def store_email(
+    email:, folder:,
+    uid: 1,
+    from: "sender@example.com",
+    subject: "The Subject",
+    body: "body"
+  )
+    account = config.accounts.find { |a| a.username == email }
+    raise "Account not found" if !account
+    FileUtils.mkdir_p account.local_path
+    store = Imap::Backup::Serializer::MboxStore.new(account.local_path, folder)
+    store.uid_validity = "42" if !store.uid_validity
+    serialized = to_serialized(from: from, subject: subject, body: body)
+    store.add(uid, serialized)
+  end
+
+  def to_serialized(from:, subject:, body:)
+    body_and_headers = <<~BODY
+      From: #{from}
+      Subject: #{subject}
+
+      #{body}
+    BODY
+  end
+
+  def config
+    Imap::Backup::Configuration.new(
+      File.expand_path("~/.imap-backup/config.json")
+    )
+  end
+end
+
+RSpec.configure do |config|
+  config.include ConfigurationHelpers, type: :aruba
+  config.include StoreHelpers, type: :aruba
+  config.include BackupDirectoryHelpers, type: :aruba
+
+  config.before(:suite) do
+    FileUtils.rm_rf "./tmp/home"
+  end
+
+  config.after do
+    FileUtils.rm_rf "./tmp/home"
+  end
+end

data/spec/features/support/backup_directory.rb

@@ -41,7 +41,3 @@ module BackupDirectoryHelpers
     JSON.parse(imap_content(name), symbolize_names: true)
   end
 end
-
-RSpec.configure do |config|
-  config.include BackupDirectoryHelpers, type: :feature
-end

data/spec/features/support/email_server.rb

@@ -87,7 +87,6 @@ module EmailServerHelpers
     imap.delete folder
     imap.disconnect
   rescue StandardError => e
-    puts e.to_s
   ensure
     @imap = nil
   end
@@ -106,5 +105,6 @@ module EmailServerHelpers
 end
 
 RSpec.configure do |config|
+  config.include EmailServerHelpers, type: :aruba
   config.include EmailServerHelpers, type: :feature
 end

data/spec/spec_helper.rb

@@ -3,10 +3,9 @@ require "rspec"
 
 CodeClimate::TestReporter.start
 
-spec_path = File.dirname(__FILE__)
-$LOAD_PATH << File.expand_path("../lib", spec_path)
+$LOAD_PATH << File.expand_path("../lib", __dir__)
 
-support_glob = File.join(spec_path, "support", "**", "*.rb")
+support_glob = File.join(__dir__, "support", "**", "*.rb")
 Dir[support_glob].sort.each { |f| require f }
 
 require "simplecov"

data/spec/unit/imap/backup/account/connection_spec.rb

@@ -61,14 +61,6 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  describe "#initialize" do
-    it "creates the path" do
-      expect(Imap::Backup::Utils).to receive(:make_folder)
-
-      subject
-    end
-  end
-
   describe "#client" do
     let(:result) { subject.client }
 
@@ -127,6 +119,12 @@ describe Imap::Backup::Account::Connection do
       allow(Imap::Backup::Serializer::Mbox).to receive(:new) { serializer }
     end
 
+    it "creates the path" do
+      expect(Imap::Backup::Utils).to receive(:make_folder)
+
+      subject.status
+    end
+
     it "returns the names of folders" do
       expect(subject.status[0][:name]).to eq(IMAP_FOLDER)
     end

data/spec/unit/imap/backup/account/folder_spec.rb

@@ -12,7 +12,10 @@ describe Imap::Backup::Account::Folder do
       append: append_response,
       create: nil,
       examine: nil,
-      responses: responses
+      expunge: nil,
+      responses: responses,
+      select: nil,
+      uid_store: nil
     )
   end
   let(:connection) do
@@ -27,12 +30,11 @@ describe Imap::Backup::Account::Folder do
   end
   let(:responses) { [] }
   let(:append_response) { nil }
+  let(:uids) { [5678, 123] }
 
-  describe "#uids" do
-    let(:uids) { [5678, 123] }
-
-    before { allow(client).to receive(:uid_search) { uids } }
+  before { allow(client).to receive(:uid_search) { uids } }
 
+  describe "#uids" do
     it "lists available messages" do
       expect(subject.uids).to eq(uids.reverse)
     end
@@ -233,6 +235,25 @@ describe Imap::Backup::Account::Folder do
       expect(subject.uid_validity).to eq(1)
     end
   end
+
+  describe "#clear" do
+    before do
+      subject.clear
+    end
+
+    it "uses select to have read-write access" do
+      expect(client).to have_received(:select)
+    end
+
+    it "marks all emails as deleted" do
+      expect(client).
+        to have_received(:uid_store).with(uids.sort, "+FLAGS", [:Deleted])
+    end
+
+    it "deletes marked emails" do
+      expect(client).to have_received(:expunge)
+    end
+  end
 end
 
 # rubocop:enable RSpec/PredicateMatcher

data/spec/unit/imap/backup/cli/helpers_spec.rb

@@ -0,0 +1,87 @@
+require "imap/backup/cli/helpers"
+
+module Imap::Backup
+  class WithHelpers
+    include CLI::Helpers
+  end
+
+  RSpec.describe CLI::Helpers do
+    subject { WithHelpers.new }
+
+    let(:accounts) { instance_double(CLI::Accounts) }
+    let(:email) { "email@example.com" }
+    let(:account1) { instance_double(Account, username: email, connection: "c1") }
+    let(:account2) { instance_double(Account, username: "foo", connection: "c2") }
+    let(:items) { [account1, account2] }
+
+    before do
+      allow(CLI::Accounts).to receive(:new) { accounts }
+      allow(accounts).to receive(:each).
+        and_yield(account1).
+        and_yield(account2)
+      allow(accounts).to receive(:find) do |&block|
+        items.find { |a| block.call(a) }
+      end
+    end
+
+    describe ".symbolized" do
+      let(:arguments) { {"foo" => 1, "bar" => 2} }
+      let(:result) { subject.symbolized(arguments) }
+
+      it "converts string keys to symbols" do
+        expect(result.keys).to eq([:foo, :bar])
+      end
+
+      context "when keys have hyphens" do
+        let(:arguments) { {"some-option"=> 3} }
+
+        it "replaces them with underscores" do
+          expect(result.keys).to eq([:some_option])
+        end
+      end
+    end
+
+    describe ".account" do
+      it "returns any account with a matching username" do
+        expect(subject.account(email)).to eq(account1)
+      end
+
+      context "when no match is found" do
+        let(:items) { [account2] }
+        it "fails" do
+          expect do
+            subject.account(email)
+          end.to raise_error(RuntimeError, /not a configured account/)
+        end
+      end
+    end
+
+    describe ".connection" do
+      it "returns the connection for any account with a matching username" do
+        result = subject.connection(email)
+        expect(result).to be_a(Account::Connection)
+        expect(result.account).to eq(account1)
+      end
+    end
+
+    describe ".each_connection" do
+      it "yields each connection" do
+        expect { |b| subject.each_connection([email, "foo"], &b) }.
+          to yield_successive_args("c1", "c2")
+      end
+
+      context "when there is no configuration" do
+        before do
+          allow(accounts).to receive(:each).
+            and_raise(Imap::Backup::ConfigurationNotFound)
+        end
+
+        it "fails" do
+          expect do
+            subject.each_connection([email])
+          end.to raise_error(RuntimeError, /not configured/)
+        end
+      end
+    end
+  end
+end

data/spec/unit/imap/backup/migrator_spec.rb

@@ -0,0 +1,58 @@
+require "imap/backup/migrator"
+
+module Imap::Backup
+  RSpec.describe Migrator do
+    subject { described_class.new(serializer, folder, reset: reset) }
+
+    let(:serializer) { instance_double(Serializer::MboxStore, uids: [1]) }
+    let(:folder) do
+      instance_double(
+        Account::Folder,
+        append: nil, clear: nil, create: nil, name: "name", uids: folder_uids
+      )
+    end
+    let(:folder_uids) { [] }
+    let(:reset) { false }
+    let(:messages) { [[1, message]] }
+    let(:message) { instance_double(Email::Mboxrd::Message, supplied_body: body) }
+    let(:body) { "body" }
+
+    before do
+      allow(serializer).to receive(:each_message) do
+        messages.enum_for(:each)
+      end
+    end
+
+    it "creates the folder" do
+      subject.run
+
+      expect(folder).to have_received(:create)
+    end
+
+    it "uploads messages" do
+      subject.run
+
+      expect(folder).to have_received(:append).with(message)
+    end
+
+    context "when the folder is not empty" do
+      let(:folder_uids) { [99] }
+
+      it "fails" do
+        expect do
+          subject.run
+        end.to raise_error(RuntimeError, /The destination folder 'name' is not empty/)
+      end
+
+      context "when `reset` is true" do
+        let(:reset) { true }
+
+        it "clears the folder" do
+          subject.run
+
+          expect(folder).to have_received(:clear)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: thunderbird
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +224,8 @@ files:
 - lib/imap/backup/cli/folders.rb
 - lib/imap/backup/cli/helpers.rb
 - lib/imap/backup/cli/local.rb
+- lib/imap/backup/cli/migrate.rb
+- lib/imap/backup/cli/remote.rb
 - lib/imap/backup/cli/restore.rb
 - lib/imap/backup/cli/setup.rb
 - lib/imap/backup/cli/status.rb
@@ -205,6 +235,7 @@ files:
 - lib/imap/backup/configuration.rb
 - lib/imap/backup/downloader.rb
 - lib/imap/backup/logger.rb
+- lib/imap/backup/migrator.rb
 - lib/imap/backup/sanitizer.rb
 - lib/imap/backup/serializer.rb
 - lib/imap/backup/serializer/mbox.rb
@@ -221,23 +252,25 @@ files:
 - lib/imap/backup/utils.rb
 - lib/imap/backup/version.rb
 - lib/retry_on_error.rb
-- lib/thunderbird.rb
-- lib/thunderbird/install.rb
-- lib/thunderbird/local_folder.rb
-- lib/thunderbird/profile.rb
-- lib/thunderbird/profiles.rb
-- lib/thunderbird/subdirectory.rb
-- lib/thunderbird/subdirectory_placeholder.rb
 - spec/features/backup_spec.rb
+- spec/features/configuration/minimal_configuration.rb
+- spec/features/configuration/missing_configuration.rb
+- spec/features/folders_spec.rb
 - spec/features/helper.rb
+- spec/features/local/list_accounts_spec.rb
+- spec/features/local/list_emails_spec.rb
+- spec/features/local/list_folders_spec.rb
+- spec/features/local/show_an_email_spec.rb
+- spec/features/migrate_spec.rb
+- spec/features/remote/list_account_folders_spec.rb
 - spec/features/restore_spec.rb
 - spec/features/status_spec.rb
+- spec/features/support/aruba.rb
 - spec/features/support/backup_directory.rb
 - spec/features/support/email_server.rb
 - spec/features/support/shared/connection_context.rb
 - spec/features/support/shared/message_fixtures.rb
 - spec/fixtures/connection.yml
-- spec/gather_rspec_coverage.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
 - spec/support/higline_test_helpers.rb
@@ -251,12 +284,14 @@ files:
 - spec/unit/imap/backup/account/connection_spec.rb
 - spec/unit/imap/backup/account/folder_spec.rb
 - spec/unit/imap/backup/cli/accounts_spec.rb
+- spec/unit/imap/backup/cli/helpers_spec.rb
 - spec/unit/imap/backup/cli/local_spec.rb
 - spec/unit/imap/backup/cli/utils_spec.rb
 - spec/unit/imap/backup/client/default_spec.rb
 - spec/unit/imap/backup/configuration_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
 - spec/unit/imap/backup/logger_spec.rb
+- spec/unit/imap/backup/migrator_spec.rb
 - spec/unit/imap/backup/serializer/mbox_enumerator_spec.rb
 - spec/unit/imap/backup/serializer/mbox_spec.rb
 - spec/unit/imap/backup/serializer/mbox_store_spec.rb
@@ -302,10 +337,12 @@ test_files:
 - spec/unit/imap/backup/setup/connection_tester_spec.rb
 - spec/unit/imap/backup/setup/asker_spec.rb
 - spec/unit/imap/backup/setup/folder_chooser_spec.rb
+- spec/unit/imap/backup/cli/helpers_spec.rb
 - spec/unit/imap/backup/cli/accounts_spec.rb
 - spec/unit/imap/backup/cli/utils_spec.rb
 - spec/unit/imap/backup/cli/local_spec.rb
 - spec/unit/imap/backup/downloader_spec.rb
+- spec/unit/imap/backup/migrator_spec.rb
 - spec/unit/imap/backup/uploader_spec.rb
 - spec/unit/imap/backup/account/folder_spec.rb
 - spec/unit/imap/backup/account/connection_spec.rb
@@ -317,16 +354,25 @@ test_files:
 - spec/unit/email/provider/fastmail_spec.rb
 - spec/unit/email/provider/base_spec.rb
 - spec/unit/email/provider_spec.rb
+- spec/features/folders_spec.rb
+- spec/features/configuration/missing_configuration.rb
+- spec/features/configuration/minimal_configuration.rb
 - spec/features/backup_spec.rb
 - spec/features/helper.rb
 - spec/features/restore_spec.rb
+- spec/features/local/list_emails_spec.rb
+- spec/features/local/list_accounts_spec.rb
+- spec/features/local/show_an_email_spec.rb
+- spec/features/local/list_folders_spec.rb
 - spec/features/status_spec.rb
 - spec/features/support/email_server.rb
 - spec/features/support/backup_directory.rb
+- spec/features/support/aruba.rb
 - spec/features/support/shared/connection_context.rb
 - spec/features/support/shared/message_fixtures.rb
+- spec/features/migrate_spec.rb
+- spec/features/remote/list_account_folders_spec.rb
 - spec/support/fixtures.rb
 - spec/support/silence_logging.rb
 - spec/support/higline_test_helpers.rb
 - spec/fixtures/connection.yml
-- spec/gather_rspec_coverage.rb