postfix_admin 0.0.2 → 0.1.0

data/spec/postfix_admin.conf

@@ -0,0 +1,5 @@
+---
+database: 'sqlite::memory:'
+aliases: 30
+mailboxes: 30
+maxquota: 100

data/spec/postfix_test.sql

@@ -0,0 +1,250 @@
+-- phpMyAdmin SQL Dump
+-- version 3.4.7
+-- http://www.phpmyadmin.net
+--
+-- ホスト: localhost
+-- 生成時間: 2012 年 9 月 25 日 23:12
+-- サーバのバージョン: 5.5.15
+-- PHP のバージョン: 5.3.15
+
+SET SQL_MODE="NO_AUTO_VALUE_ON_ZERO";
+SET time_zone = "+00:00";
+
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!40101 SET NAMES utf8 */;
+
+--
+-- データベース: `postfix_test`
+--
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `admin`
+--
+
+CREATE TABLE IF NOT EXISTS `admin` (
+  `username` varchar(255) NOT NULL DEFAULT '',
+  `password` varchar(255) NOT NULL DEFAULT '',
+  `created` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `modified` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `active` tinyint(1) NOT NULL DEFAULT '1',
+  PRIMARY KEY (`username`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postfix Admin - Virtual Admins';
+
+--
+-- テーブルのデータをダンプしています `admin`
+--
+
+INSERT INTO `admin` (`username`, `password`, `created`, `modified`, `active`) VALUES
+('all@example.com', 'password', '2012-08-31 15:39:02', '2012-08-31 15:39:19', 1),
+('admin@example.com', 'password', '2012-08-31 10:27:58', '2012-08-31 10:28:16', 1);
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `alias`
+--
+
+CREATE TABLE IF NOT EXISTS `alias` (
+  `address` varchar(255) NOT NULL DEFAULT '',
+  `goto` text NOT NULL,
+  `domain` varchar(255) NOT NULL DEFAULT '',
+  `created` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `modified` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `active` tinyint(1) NOT NULL DEFAULT '1',
+  PRIMARY KEY (`address`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postfix Admin - Virtual Aliases';
+
+--
+-- テーブルのデータをダンプしています `alias`
+--
+
+INSERT INTO `alias` (`address`, `goto`, `domain`, `created`, `modified`, `active`) VALUES
+('user@example.com', 'user@example.com', 'example.com', '2012-08-31 10:24:12', '2012-08-31 10:24:12', 1);
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `config`
+--
+
+CREATE TABLE IF NOT EXISTS `config` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(20) CHARACTER SET latin1 NOT NULL DEFAULT '',
+  `value` varchar(20) CHARACTER SET latin1 NOT NULL DEFAULT '',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `name` (`name`)
+) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='PostfixAdmin settings' AUTO_INCREMENT=2 ;
+
+--
+-- テーブルのデータをダンプしています `config`
+--
+
+INSERT INTO `config` (`id`, `name`, `value`) VALUES
+(1, 'version', '352');
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `domain`
+--
+
+CREATE TABLE IF NOT EXISTS `domain` (
+  `domain` varchar(255) NOT NULL DEFAULT '',
+  `description` varchar(255) NOT NULL DEFAULT '',
+  `aliases` int(10) NOT NULL DEFAULT '0',
+  `mailboxes` int(10) NOT NULL DEFAULT '0',
+  `maxquota` bigint(20) NOT NULL DEFAULT '0',
+  `quota` bigint(20) NOT NULL DEFAULT '0',
+  `transport` varchar(255) DEFAULT NULL,
+  `backupmx` tinyint(1) NOT NULL DEFAULT '0',
+  `created` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `modified` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `active` tinyint(1) NOT NULL DEFAULT '1',
+  PRIMARY KEY (`domain`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postfix Admin - Virtual Domains';
+
+--
+-- テーブルのデータをダンプしています `domain`
+--
+
+INSERT INTO `domain` (`domain`, `description`, `aliases`, `mailboxes`, `maxquota`, `quota`, `transport`, `backupmx`, `created`, `modified`, `active`) VALUES
+('ALL', '', 0, 0, 0, 0, NULL, 0, '0000-00-00 00:00:00', '0000-00-00 00:00:00', 1),
+('example.com', '', 100, 100, 100, 0, 'virtual', 0, '2012-08-31 10:21:49', '2012-08-31 10:21:49', 1);
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `domain_admins`
+--
+
+CREATE TABLE IF NOT EXISTS `domain_admins` (
+  `username` varchar(255) NOT NULL DEFAULT '',
+  `domain` varchar(255) NOT NULL DEFAULT '',
+  `created` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `active` tinyint(1) NOT NULL DEFAULT '1',
+  KEY `username` (`username`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postfix Admin - Domain Admins';
+
+--
+-- テーブルのデータをダンプしています `domain_admins`
+--
+
+INSERT INTO `domain_admins` (`username`, `domain`, `created`, `active`) VALUES
+('all@example.com', 'ALL', '2012-08-31 15:39:19', 1),
+('admin@example.com', 'example.com', '2012-08-31 10:28:16', 1);
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `fetchmail`
+--
+
+CREATE TABLE IF NOT EXISTS `fetchmail` (
+  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+  `mailbox` varchar(255) NOT NULL DEFAULT '',
+  `src_server` varchar(255) NOT NULL DEFAULT '',
+  `src_auth` enum('password','kerberos_v5','kerberos','kerberos_v4','gssapi','cram-md5','otp','ntlm','msn','ssh','any') DEFAULT NULL,
+  `src_user` varchar(255) NOT NULL DEFAULT '',
+  `src_password` varchar(255) NOT NULL DEFAULT '',
+  `src_folder` varchar(255) NOT NULL DEFAULT '',
+  `poll_time` int(11) unsigned NOT NULL DEFAULT '10',
+  `fetchall` tinyint(1) unsigned NOT NULL DEFAULT '0',
+  `keep` tinyint(1) unsigned NOT NULL DEFAULT '0',
+  `protocol` enum('POP3','IMAP','POP2','ETRN','AUTO') DEFAULT NULL,
+  `extra_options` text,
+  `returned_text` text,
+  `mda` varchar(255) NOT NULL DEFAULT '',
+  `date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+  PRIMARY KEY (`id`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `log`
+--
+
+CREATE TABLE IF NOT EXISTS `log` (
+  `timestamp` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `username` varchar(255) NOT NULL DEFAULT '',
+  `domain` varchar(255) NOT NULL DEFAULT '',
+  `action` varchar(255) NOT NULL DEFAULT '',
+  `data` varchar(255) NOT NULL DEFAULT '',
+  KEY `timestamp` (`timestamp`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postfix Admin - Log';
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `mailbox`
+--
+
+CREATE TABLE IF NOT EXISTS `mailbox` (
+  `username` varchar(255) NOT NULL DEFAULT '',
+  `password` varchar(255) NOT NULL DEFAULT '',
+  `name` varchar(255) NOT NULL DEFAULT '',
+  `maildir` varchar(255) NOT NULL DEFAULT '',
+  `quota` bigint(20) NOT NULL DEFAULT '0',
+  `domain` varchar(255) NOT NULL DEFAULT '',
+  `created` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `modified` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `active` tinyint(1) NOT NULL DEFAULT '1',
+  PRIMARY KEY (`username`)
+) ENGINE=MyISAM DEFAULT CHARSET=utf8 COMMENT='Postfix Admin - Virtual Mailboxes';
+
+--
+-- テーブルのデータをダンプしています `mailbox`
+--
+
+INSERT INTO `mailbox` (`username`, `password`, `name`, `maildir`, `quota`, `domain`, `created`, `modified`, `active`) VALUES
+('user@example.com', 'password', '', 'example.com/user@example.com/', 102400000, 'example.com', '2012-08-31 10:24:12', '2012-08-31 10:24:12', 1);
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `vacation`
+--
+
+CREATE TABLE IF NOT EXISTS `vacation` (
+  `email` varchar(255) NOT NULL,
+  `subject` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL,
+  `body` text CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL,
+  `cache` text NOT NULL,
+  `domain` varchar(255) NOT NULL,
+  `created` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
+  `active` tinyint(1) NOT NULL DEFAULT '1',
+  PRIMARY KEY (`email`),
+  KEY `email` (`email`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='Postfix Admin - Virtual Vacation';
+
+-- --------------------------------------------------------
+
+--
+-- テーブルの構造 `vacation_notification`
+--
+
+CREATE TABLE IF NOT EXISTS `vacation_notification` (
+  `on_vacation` varchar(255) NOT NULL,
+  `notified` varchar(255) NOT NULL,
+  `notified_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (`on_vacation`,`notified`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1 COMMENT='Postfix Admin - Virtual Vacation Notifications';
+
+--
+-- ダンプしたテーブルの制約
+--
+
+--
+-- テーブルの制約 `vacation_notification`
+--
+ALTER TABLE `vacation_notification`
+  ADD CONSTRAINT `vacation_notification_pkey` FOREIGN KEY (`on_vacation`) REFERENCES `vacation` (`email`) ON DELETE CASCADE;
+
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;

data/spec/runner_spec.rb

@@ -0,0 +1,144 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+require 'postfix_admin/runner'
+
+describe PostfixAdmin::Runner do
+  before do
+    db_initialize
+  end
+
+  it "version" do
+    capture(:stdout){ Runner.start(["version"]) }.should =~ /postfix_admin \d+\.\d+\.\d/
+  end
+
+  it "summary" do
+    capture(:stdout){ Runner.start(["summary"]) }.should =~ /\[Summary\]/
+    capture(:stdout){ Runner.start(["summary", "example.com"]) }.should =~ /\[Summary of example.com\]/
+  end
+
+  describe "show" do
+    it "shows information of example.com" do
+     capture(:stdout){ Runner.start(["show"]) }.should =~ /example.com\s+1\s+\/\s+30\s+1\s+\/\s+30\s+100/
+    end
+
+    it "shows information of admin@example.com" do
+      capture(:stdout){ Runner.start(["show"]) }.should =~ /admin@example.com\s+1\s+password/
+    end
+
+    it "show the detail of example.com" do
+      capture(:stdout){ Runner.start(["show", "example.com"]) }.should =~ /user@example.com\s+100.0\s+password/
+    end
+
+    it "when no admins, no aliases and no addresses" do
+      Admin.find('all@example.com').super_admin = false
+      out = capture(:stdout){ Runner.start(["show", "example.org"]) }
+      out.should =~ /No admins/
+      out.should =~ /No addresses/
+      out.should =~ /No aliases/
+    end
+
+    it "when no domains" do
+      capture(:stdout){ Runner.start(['delete_domain', 'example.com']) }.should =~ EX_DELETED
+      capture(:stdout){ Runner.start(['delete_domain', 'example.org']) }.should =~ EX_DELETED
+      capture(:stdout){ Runner.start(["show"]) }.should =~ /No domains/
+    end
+  end
+
+  it "setup" do
+    capture(:stdout){ Runner.start(['setup', 'example.net', 'password']) }.should =~ EX_REGISTERED
+    capture(:stdout){ Runner.start(['delete_domain', 'example.net']) }.should =~ EX_DELETED
+  end
+
+  describe "super_admin" do
+    it "can enable super admin flag of an admin" do
+      capture(:stdout){ Runner.start(['super', 'admin@example.com']) }.should =~ /Successfully enabled/
+    end
+
+    it "can disable super admin flag of an admin (--disable)" do
+      capture(:stdout){ Runner.start(['super', 'admin@example.com', '--disable']) }.should =~ /Successfully disabled/
+    end
+
+    it "can use -d option as --disable" do
+      capture(:stdout){ Runner.start(['super', 'admin@example.com', '-d']) }.should =~ /Successfully disabled/
+    end
+  end
+
+  describe "admin_passwd" do
+    it "can change password of an admin" do
+      capture(:stdout){ Runner.start(['admin_passwd', 'admin@example.com', 'new_password']) }.should =~ /successfully changed/
+    end
+
+    it "can not use too short password (< 5)" do
+      capture(:stderr){ Runner.start(['admin_passwd', 'admin@example.com', '124']) }.should =~ /too short/
+    end
+
+    it "can not use for unknown admin" do
+      capture(:stderr){ Runner.start(['admin_passwd', 'unknown@example.com', 'new_password']) }.should =~ /Could not find/
+    end
+  end
+
+  describe "account_passwd" do
+    it "can change password of an account" do
+      capture(:stdout){ Runner.start(['account_passwd', 'user@example.com', 'new_password']) }.should =~ /successfully changed/
+    end
+
+    it "can not use too short password (< 5)" do
+      capture(:stderr){ Runner.start(['account_passwd', 'user@example.com', '1234']) }.should =~ /too short/
+    end
+
+    it "can not use for unknown account" do
+      capture(:stderr){ Runner.start(['account_passwd', 'unknown@example.com', 'new_password']) }.should =~ /Could not find/
+    end
+  end
+
+  describe "add_alias and delete_alias" do
+    it "can add and delete an new alias." do
+      capture(:stdout){ Runner.start(['add_alias', 'new_alias@example.com', 'goto@example.jp']) }.should =~ EX_REGISTERED
+      capture(:stdout){ Runner.start(['delete_alias', 'new_alias@example.com']) }.should =~ EX_DELETED
+    end
+
+    it "can not delete mailbox alias." do
+      capture(:stderr){ Runner.start(['delete_alias', 'user@example.com']) }.should =~ /Can not delete mailbox/
+    end
+
+    it "can not add an alias for existed mailbox" do
+      capture(:stderr){ Runner.start(['add_alias', 'user@example.com', 'goto@example.jp']) }.should =~ /mailbox user@example.com is already registered!/
+    end
+  end
+
+  describe "add_admin" do
+    it "can add an new admin" do
+      capture(:stdout){ Runner.start(['add_admin', 'admin@example.jp', 'password']) }.should =~ EX_REGISTERED
+    end
+
+    it "--super option" do
+      capture(:stdout){ Runner.start(['add_admin', 'admin@example.jp', 'password', '--super']) }.should =~ /registered as a super admin/
+    end
+
+    it "-s (--super) option" do
+      capture(:stdout){ Runner.start(['add_admin', 'admin@example.jp', 'password', '-s']) }.should =~ /registered as a super admin/
+    end
+  end
+
+  it "add_admin_domain" do
+    capture(:stdout){ Runner.start(['add_admin_domain', 'admin@example.com', 'example.org']) }.should =~ EX_REGISTERED
+  end
+
+  it "delete_admin" do
+    capture(:stdout){ Runner.start(['delete_admin', 'admin@example.com']) }.should =~ EX_DELETED
+  end
+
+  it "add_account and delete_account" do
+    capture(:stdout){ Runner.start(['add_account', 'user2@example.com', 'password']) }.should =~ EX_REGISTERED
+    capture(:stdout){ Runner.start(['delete_account', 'user2@example.com']) }.should =~ EX_DELETED
+  end
+
+  it "add and delete methods" do
+    lambda { Runner.start(['add_domain', 'example.net']) }.should_not raise_error
+    Runner.start(['add_admin', 'admin@example.net', 'password'])
+    Runner.start(['add_admin_domain', 'admin@example.net', 'example.net'])
+
+    lambda { Runner.start(['add_account', 'user1@example.net', 'password']) }.should_not raise_error
+    lambda { Runner.start(['add_account', 'user2@example.net', 'password']) }.should_not raise_error
+    lambda { Runner.start(['delete_domain', 'example.net']) }.should_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,160 @@
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'postfix_admin'
+
+module PostfixAdmin
+  class CLI
+    def config_file
+      File.join(File.dirname(__FILE__) , 'postfix_admin.conf')
+    end
+  end
+end
+
+include PostfixAdmin
+
+# [fixtures]
+# Domain:
+#  ALL
+#  example.com
+#  example.org
+#
+# Admin:
+#  all@example.com   Super Admin
+#  admin@example.com
+#
+# Mailbox, Alias:
+#  user@example.com
+#
+# Alias:
+#  alias@example.com
+
+def db_clear
+  DomainAdmin.all.destroy
+  Mailbox.all.destroy
+  Alias.all.destroy
+  Domain.all.destroy
+  Admin.all.destroy
+end
+
+def create_domain(domain_name)
+  domain = Domain.new
+  domain.attributes = {
+    :domain_name  => domain_name,
+    :description  => domain_name,
+    :maxaliases   => 30,
+    :maxmailboxes => 30,
+    :maxquota     => 100,
+  }
+  domain.save
+end
+
+def db_initialize
+  db_clear
+
+  create_domain('ALL')
+  create_domain('example.com')
+  create_domain('example.org')
+
+  username = "admin@example.com"
+  admin = Admin.new
+  admin.attributes = {
+    :username => username,
+    :password => 'password',
+  }
+  admin.save
+
+  domain = Domain.find('example.com')
+  domain.admins << admin
+  domain.save
+
+  all_admin = Admin.new
+  all_admin.attributes = {
+    :username => 'all@example.com',
+    :password => 'password',
+  }
+  all_admin.save
+
+  all_domain = Domain.find('ALL')
+  all_domain.admins << all_admin
+  all_domain.save
+
+  address = "user@example.com"
+  mail_alias = Alias.new
+  mail_alias.attributes = {
+    :address  => address,
+    :goto     => address,
+  }
+  domain.aliases << mail_alias
+
+  forward = Alias.new
+  forward.attributes = {
+    :address  => 'alias@example.com',
+    :goto     => 'example.jp',
+  }
+  domain.aliases << forward
+
+  domain.save
+
+  path = "example.com/user@example.com/"
+  mailbox = Mailbox.new
+  mailbox.attributes = {
+    :username => address,
+    :password => 'password',
+    :name     => '',
+    :maildir  => path,
+    :quota    => 100 * 1024 * 1000,
+    # :local_part => user,
+  }
+  domain.mailboxes << mailbox
+  domain.save
+end
+
+DataMapper.setup(:default, 'sqlite::memory:')
+DataMapper.finalize
+DataMapper.auto_migrate!
+db_initialize
+
+module PostfixAdmin
+  class Base
+
+    # without DataMapper setup
+    def db_setup(database)
+      unless database
+        raise ArgumentError
+      end
+    end
+  end
+end
+
+EX_DELETED    = /successfully deleted/
+EX_REGISTERED = /successfully registered/
+
+RSpec.configure do |config|
+  config.before do
+    ARGV.replace []
+  end
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+
+  def source_root
+    File.join(File.dirname(__FILE__), 'fixtures')
+  end
+
+  def destination_root
+    File.join(File.dirname(__FILE__), 'sandbox')
+  end
+
+  alias :silence :capture
+end