mailshears 0.0.1

data/test/test_mv.rb

@@ -0,0 +1,174 @@
+# WARNING: Test output is dependent on the order these classes include
+# certain modules; i.e. on the 'require' order.
+require 'common/domain'
+require 'common/user'
+require 'mailshears_test'
+require 'mv/plugins/agendav'
+require 'mv/plugins/davical'
+require 'mv/plugins/dovecot'
+require 'mv/plugins/postfixadmin'
+require 'mv/plugins/roundcube'
+require 'mv/mv_runner'
+
+
+class TestMv < MailshearsTest
+
+  def test_mv_once
+    cfg = configuration()
+    src = User.new("alice@example.com")
+    dst = User.new("alice@example.net")
+
+    output_buffer = StringIO.new()
+
+    $stdout = output_buffer
+    MvPlugin.run(cfg, src, dst)
+    $stdout = STDOUT
+
+    actual = output_buffer.string()
+
+    expected =
+      "AgendavMv - Source user alice@example.com not found.\n" +
+      "DavicalMv - Moved user alice@example.com (Principal ID: 1) " +
+        "to alice@example.net (Principal ID: 1).\n" +
+      "DovecotMv - Moved user alice@example.com " +
+        "(#{cfg.dovecot_mail_root()}/example.com/alice) to " +
+        "alice@example.net (#{cfg.dovecot_mail_root()}/example.net/alice).\n" +
+      "PostfixadminMv - Moved user alice@example.com to alice@example.net.\n" +
+      "RoundcubeMv - Moved user alice@example.com (User ID: 1) to " +
+        "alice@example.net (User ID: 1).\n"
+
+    assert_equal(expected, actual)
+
+    # Now check the database.
+
+    amv = AgendavMv.new(cfg)
+    actual = amv.list_users()
+    expected = [User.new('adam@example.net'),User.new('booger@example.com')]
+    assert_equal(expected.sort(), actual.sort())
+
+    dmv = DavicalMv.new(cfg)
+    actual = dmv.list_users()
+    expected = [User.new('alice@example.net'), User.new('booger@example.com')]
+    assert_equal(expected.sort(), actual.sort())
+
+    pfamv = PostfixadminMv.new(cfg)
+    actual = pfamv.list_users()
+    expected = [User.new('alice@example.net'),
+                User.new('bob@example.com'),
+                User.new('adam@example.net'),
+                User.new('beth@example.net'),
+                User.new('carol@example.net')]
+    assert_equal(expected.sort(), actual.sort())
+
+    actual = pfamv.list_domains()
+    expected = [Domain.new('example.com'), Domain.new('example.net')]
+    assert_equal(expected.sort(), actual.sort())
+
+    actual = pfamv.list_aliases()
+    expected = [{'address' => 'adam@example.net',
+                 'goto' => 'adam@example.net'},
+                {'address' => 'alice@example.net',
+                 'goto' => 'alice@example.net,' +
+                           'adam@example.net,' +
+                           'bob@example.com,' +
+                           'carol@example.net'},
+                {'address' => 'beth@example.net',
+                 'goto' => 'beth@example.net'},
+                {'address' => 'bob@example.com',
+                 'goto' => 'bob@example.com'},
+                {'address' => 'carol@example.net',
+                 'goto' => 'carol@example.net'}]
+    expected.each { |e| assert(actual.include?(e)) } # can't sort dicts
+    actual.each { |a| assert(expected.include?(a)) } # can't sort dicts
+
+
+    rmv = RoundcubeMv.new(cfg)
+    actual = rmv.list_users()
+    expected = [User.new('alice@example.net'),
+                User.new('booger@example.com'),
+                User.new('adam@example.net')]
+    assert_equal(expected.sort(), actual.sort())
+
+    # All the maildirs are still there.
+    assert(maildir_exists('example.net/alice'))
+    assert(maildir_exists('example.com/booger'))
+    assert(maildir_exists('example.com/jeremy'))
+    assert(maildir_exists('example.net/adam'))
+  end
+
+
+  def test_mv_twice
+    #
+    # If we move a user and then move it back, we should wind up back
+    # where we started.
+    #
+    cfg = configuration()
+    src = User.new("alice@example.com")
+    dst = User.new("alice@example.net")
+
+    output_buffer = StringIO.new()
+
+    $stdout = output_buffer
+    MvPlugin.run(cfg, src, dst)
+    MvPlugin.run(cfg, dst, src)
+    $stdout = STDOUT
+
+    # Skip output verification, it's ugly. But make sure the database
+    # has what we expect.
+
+    amv = AgendavMv.new(cfg)
+    actual = amv.list_users()
+    expected = [User.new('adam@example.net'),User.new('booger@example.com')]
+    assert_equal(expected.sort(), actual.sort())
+
+    dmv = DavicalMv.new(cfg)
+    actual = dmv.list_users()
+    expected = [User.new('alice@example.com'), User.new('booger@example.com')]
+    assert_equal(expected.sort(), actual.sort())
+
+    pfamv = PostfixadminMv.new(cfg)
+    actual = pfamv.list_users()
+    expected = [User.new('alice@example.com'),
+                User.new('bob@example.com'),
+                User.new('adam@example.net'),
+                User.new('beth@example.net'),
+                User.new('carol@example.net')]
+    assert_equal(expected.sort(), actual.sort())
+
+    actual = pfamv.list_domains()
+    expected = [Domain.new('example.com'), Domain.new('example.net')]
+    assert_equal(expected.sort(), actual.sort())
+
+    actual = pfamv.list_aliases()
+    expected = [{'address' => 'adam@example.net',
+                 'goto' => 'adam@example.net'},
+                {'address' => 'alice@example.com',
+                 'goto' => 'alice@example.com,' +
+                           'adam@example.net,' +
+                           'bob@example.com,' +
+                           'carol@example.net'},
+                {'address' => 'beth@example.net',
+                 'goto' => 'beth@example.net'},
+                {'address' => 'bob@example.com',
+                 'goto' => 'bob@example.com'},
+                {'address' => 'carol@example.net',
+                 'goto' => 'carol@example.net'}]
+    expected.each { |e| assert(actual.include?(e)) } # can't sort dicts
+    actual.each { |a| assert(expected.include?(a)) } # can't sort dicts
+
+
+    rmv = RoundcubeMv.new(cfg)
+    actual = rmv.list_users()
+    expected = [User.new('alice@example.com'),
+                User.new('booger@example.com'),
+                User.new('adam@example.net')]
+    assert_equal(expected.sort(), actual.sort())
+
+    # All the maildirs are still there.
+    assert(maildir_exists('example.com/alice'))
+    assert(maildir_exists('example.com/booger'))
+    assert(maildir_exists('example.com/jeremy'))
+    assert(maildir_exists('example.net/adam'))
+  end
+
+end

data/test/test_prune.rb

@@ -0,0 +1,121 @@
+# WARNING: Test output is dependent on the order these classes include
+# certain modules; i.e. on the 'require' order.
+require 'common/domain'
+require 'common/user'
+require 'mailshears_test'
+require 'prune/plugins/agendav'
+require 'prune/plugins/davical'
+require 'prune/plugins/dovecot'
+require 'prune/plugins/postfixadmin'
+require 'prune/plugins/roundcube'
+require 'prune/prune_runner'
+
+
+class TestPrune < MailshearsTest
+
+  def check_assertions(actual)
+    cfg = configuration()
+
+    # Both of our tests have the same expected output / results, so
+    # check them both using the same function.
+    expected =
+      "AgendavPrune - Removed user booger@example.com.\n" +
+      "DavicalPrune - Removed user booger@example.com (Principal ID: 2).\n" +
+      "DovecotPrune - Removed user booger@example.com " +
+        "(#{cfg.dovecot_mail_root()}/example.com/booger).\n" +
+      "DovecotPrune - Removed user jeremy@example.com " +
+        "(#{cfg.dovecot_mail_root()}/example.com/jeremy).\n" +
+      "RoundcubePrune - Removed user booger@example.com (User ID: 2).\n"
+
+    assert_equal(expected, actual)
+
+    # Now make sure the database has what we expect.
+
+    apr = AgendavPrune.new(cfg)
+    actual = apr.list_users()
+    expected = [User.new('adam@example.net')]
+    assert_equal(expected, actual)
+
+    dpr = DavicalPrune.new(cfg)
+    actual = dpr.list_users()
+    expected = [User.new('alice@example.com')]
+    assert_equal(expected, actual)
+
+    pfapr = PostfixadminPrune.new(cfg)
+    actual = pfapr.list_users()
+    expected = [User.new('alice@example.com'),
+                User.new('bob@example.com'),
+                User.new('adam@example.net'),
+                User.new('beth@example.net'),
+                User.new('carol@example.net')]
+    assert_equal(expected, actual)
+
+    actual = pfapr.list_domains()
+    expected = [Domain.new('example.com'), Domain.new('example.net')]
+    assert_equal(expected, actual)
+
+    actual = pfapr.list_aliases()
+    expected = [{'address' => 'adam@example.net',
+                 'goto' => 'adam@example.net'},
+                {'address' => 'alice@example.com',
+                 'goto' => 'alice@example.com,' +
+                           'adam@example.net,' +
+                           'bob@example.com,' +
+                           'carol@example.net'},
+                {'address' => 'beth@example.net',
+                 'goto' => 'beth@example.net'},
+                {'address' => 'bob@example.com',
+                 'goto' => 'bob@example.com'},
+                {'address' => 'carol@example.net',
+                 'goto' => 'carol@example.net'}]
+    expected.each { |e| assert(actual.include?(e)) } # can't sort dicts
+    actual.each { |a| assert(expected.include?(a)) } # can't sort dicts
+
+    rpr = RoundcubePrune.new(cfg)
+    actual = rpr.list_users()
+    expected = [User.new('alice@example.com'), User.new('adam@example.net')]
+    assert_equal(expected, actual)
+
+    # Booger and Jeremy should get pruned.
+    assert(maildir_exists('example.com/alice'))
+    assert(maildir_exists('example.net/adam'))
+    assert(!maildir_exists('example.com/booger'))
+    assert(!maildir_exists('example.com/jeremy'))
+  end
+
+
+  def test_single_prune()
+    # Run prune once and see what happens.
+    cfg = configuration()
+
+    output_buffer = StringIO.new()
+
+    $stdout = output_buffer
+    PrunePlugin.run(cfg)
+    $stdout = STDOUT
+
+    actual = output_buffer.string()
+
+    check_assertions(actual)
+  end
+
+
+  def test_double_prune
+    # Run prune twice. This should have the exact same output as
+    # running it once, since the second time around, there's nothing
+    # to prune.
+    cfg = configuration()
+
+    output_buffer = StringIO.new()
+
+    $stdout = output_buffer
+    PrunePlugin.run(cfg)
+    PrunePlugin.run(cfg)
+    $stdout = STDOUT
+
+    actual = output_buffer.string()
+
+    check_assertions(actual)
+  end
+
+end

data/test/test_rm.rb

@@ -0,0 +1,154 @@
+# WARNING: Test output is dependent on the order these classes include
+# certain modules; i.e. on the 'require' order.
+require 'common/domain'
+require 'common/user'
+require 'mailshears_test'
+require 'rm/plugins/agendav'
+require 'rm/plugins/davical'
+require 'rm/plugins/dovecot'
+require 'rm/plugins/postfixadmin'
+require 'rm/plugins/roundcube'
+require 'rm/rm_runner'
+
+
+class TestRm < MailshearsTest
+
+  def test_rm_user
+    cfg = configuration()
+    users = [ User.new("adam@example.net") ]
+
+    output_buffer = StringIO.new()
+
+    $stdout = output_buffer
+    RmPlugin.run(cfg, *users)
+    $stdout = STDOUT
+
+    actual = output_buffer.string()
+
+    expected =
+      "AgendavRm - Removed user adam@example.net.\n" +
+      "DavicalRm - User adam@example.net not found.\n" +
+      "DovecotRm - Removed user adam@example.net " +
+        "(#{cfg.dovecot_mail_root}/example.net/adam).\n" +
+      "PostfixadminRm - Removed user adam@example.net.\n" +
+      "RoundcubeRm - Removed user adam@example.net (User ID: 3).\n"
+
+    assert_equal(expected, actual)
+
+    # Now make sure the database has what we expect.
+
+    arm = AgendavRm.new(cfg)
+    actual = arm.list_users()
+    expected = [User.new('booger@example.com')]
+    assert_equal(expected, actual)
+
+    drm = DavicalRm.new(cfg)
+    actual = drm.list_users()
+    expected = [User.new('alice@example.com'), User.new('booger@example.com')]
+    assert_equal(expected, actual)
+
+    pfarm = PostfixadminRm.new(cfg)
+    actual = pfarm.list_users()
+    expected = [User.new('alice@example.com'),
+                User.new('bob@example.com'),
+                User.new('beth@example.net'),
+                User.new('carol@example.net')]
+    assert_equal(expected, actual)
+
+    actual = pfarm.list_domains()
+    expected = [Domain.new('example.com'), Domain.new('example.net')]
+    assert_equal(expected, actual)
+
+    actual = pfarm.list_aliases()
+    expected = [{'address' => 'alice@example.com',
+                 'goto' => 'alice@example.com,' +
+                           'bob@example.com,' +
+                           'carol@example.net'},
+                {'address' => 'beth@example.net',
+                 'goto' => 'beth@example.net'},
+                {'address' => 'bob@example.com',
+                 'goto' => 'bob@example.com'},
+                {'address' => 'carol@example.net',
+                 'goto' => 'carol@example.net'}]
+    expected.each { |e| assert(actual.include?(e)) } # can't sort dicts
+    actual.each { |a| assert(expected.include?(a)) } # can't sort dicts
+
+    rrm = RoundcubeRm.new(cfg)
+    actual = rrm.list_users()
+    expected = [User.new('alice@example.com'), User.new('booger@example.com')]
+    assert_equal(expected, actual)
+
+    # Check that adam's directory is gone but that the rest remain.
+    assert(maildir_exists('example.com/alice'))
+    assert(maildir_exists('example.com/booger'))
+    assert(maildir_exists('example.com/jeremy'))
+    assert(!maildir_exists('example.net/adam'))
+  end
+
+
+  def test_rm_domain
+    cfg = configuration()
+    domains = [Domain.new("example.net")]
+
+    output_buffer = StringIO.new()
+
+    $stdout = output_buffer
+    RmPlugin.run(cfg, *domains)
+    $stdout = STDOUT
+
+    actual = output_buffer.string()
+
+    expected =
+      "AgendavRm - Removed domain example.net.\n" +
+      "DavicalRm - Domain example.net not found.\n" +
+      "DovecotRm - Removed domain example.net " +
+        "(#{cfg.dovecot_mail_root}/example.net).\n" +
+      "PostfixadminRm - Removed domain example.net.\n" +
+      "RoundcubeRm - Removed domain example.net.\n"
+
+    assert_equal(expected, actual)
+
+    # Now make sure the database has what we expect.
+
+    arm = AgendavRm.new(cfg)
+    actual = arm.list_users()
+    expected = [User.new('booger@example.com')]
+    assert_equal(expected, actual)
+
+    drm = DavicalRm.new(cfg)
+    actual = drm.list_users()
+    expected = [User.new('alice@example.com'), User.new('booger@example.com')]
+    assert_equal(expected, actual)
+
+    pfarm = PostfixadminRm.new(cfg)
+    actual = pfarm.list_users()
+    expected = [User.new('alice@example.com'),
+                User.new('bob@example.com')]
+    assert_equal(expected, actual)
+
+    actual = pfarm.list_domains()
+    expected = [Domain.new('example.com')]
+    assert_equal(expected, actual)
+
+    actual = pfarm.list_aliases()
+    expected = [{'address' => 'alice@example.com',
+                 'goto' => 'alice@example.com,bob@example.com'},
+                {'address' => 'bob@example.com',
+                 'goto' => 'bob@example.com'}]
+    expected.each { |e| assert(actual.include?(e)) } # can't sort dicts
+    actual.each { |a| assert(expected.include?(a)) } # can't sort dicts
+
+    rrm = RoundcubeRm.new(cfg)
+    actual = rrm.list_users()
+    expected = [User.new('alice@example.com'), User.new('booger@example.com')]
+    assert_equal(expected, actual)
+
+    # Check that example.net's directory is gone but that the rest remain.
+    assert(maildir_exists('example.com/alice'))
+    assert(maildir_exists('example.com/booger'))
+    assert(maildir_exists('example.com/jeremy'))
+    assert(!maildir_exists('example.net'))
+  end
+
+
+end