postfix_admin 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a15e49758d586d12c05d2e0f15f04b123345942d9de889a3617d9cb13ca25bb
-  data.tar.gz: 9b0a5e9d4741ad9dc8562347c4ca63616bddf97b5e20e6669ae7088bbb04bb29
+  metadata.gz: 79176db25ca525f4d2031a41bf66f35895ae7d96d944af8e607c75f7654a1916
+  data.tar.gz: 5d3f6f207505ff525e4e192d6d03747bb5c7cf08e90dad5d313d93893bbb8601
 SHA512:
-  metadata.gz: eeee12bb7ba7e2d3530878a431f82bfd0c239f64b96225577d46a20e90d60f870a6df73fe96a3dbc02cc69363b380f63976074d8d0e4debd465ae0c014d337a4
-  data.tar.gz: 257ad43dfbb601927501abab85a6ecf8c0c1bc2d353f2bf7f6be93db81a50c6f27eaf685cc9c6386c5c734a0989e3909346e8aa66247dbabb77c1fb66562b40e
+  metadata.gz: be19b8e778bf216deb66d9cc922d75022fb32425036def3a8b0642086a56b81b899bf3ec5070f667926b085354a3803da82f9d9b1e09075bae181876e67ac59f
+  data.tar.gz: 6af8ea674a934b5c522880a8c7f5a0c2d1a9c41959e626280f781ff6e6b62065b870830ee288582d49cafe91c83f8c42e535b61d9c62809c510fbdf396f72174

data/.github/workflows/ci.yml

@@ -38,9 +38,9 @@ jobs:
       - name: Install dovecotpw
         run: sudo apt-get install -y dovecot-core
       - name: Copy configure file
-        run: cp ./test/misc/postfix_admin.conf ~/.postfix_admin.conf
+        run: cp ./spec/misc/postfix_admin.conf ~/.postfix_admin.conf
       - name: Copy my.cnf (for `rake setup_test_db`)
-        run: cp ./test/misc/ci.my.cnf ~/.my.cnf
+        run: cp ./spec/misc/ci.my.cnf ~/.my.cnf
       - name: docker-compose up
         run: docker-compose up -d db
       - name: Sleep (work around)
@@ -48,7 +48,5 @@ jobs:
         run: sleep 10
       - name: Set up test database
         run: bundle exec rake setup_test_db
-      - name: Run tests
-        run: bundle exec rake test
       - name: Run specs
         run: bundle exec rake spec

data/CHANGELOG.md

@@ -1,29 +1,39 @@
 # CHANGELOG
 
+## 0.3.2
+  * Added `-d` (description) option for the `setup` subcommand
+
+## 0.3.1
+  * Added `admins`, `domains`, `accounts`, `aliases` and `forwards` subcommands
+  * Added `teardown` subcommand for the opposite operation of `setup`
+  * `delete_domain` subcommand removes logs associated with the domain
+  * Added `-s` (scheme) and `-r` (rounds) options for subcommands that require password arguments
+    + Encryption rounds are supported only for `BLF-CRYPT`, `SHA256-CRYPT`, and `SHA512-CRYPT` schemes
+
 ## 0.3.0
- * Added support for table display format
- * No longer supports `dovecotpw` for password hash generation
-   + Only `doveadm pw` is supported
+  * Added support for table display format
+  * No longer supports `dovecotpw` for password hash generation
+    + Only `doveadm pw` is supported
 
 ## 0.2.1
- * Added support for the `superadmin` column in the `admin` table
- * Added `passwordhash_prefix` keyword in the configuration format for backward compatibility
+  * Added support for the `superadmin` column in the `admin` table
+  * Added `passwordhash_prefix` keyword in the configuration format for backward compatibility
 
 ## 0.2.0
- * Switched the object-relational mapper from DataMapper to ActiveRecord
- * Stored password hashes now include scheme prefixes, such as `{CRAM-MD5}` and `{PLAIN}`
+  * Switched the object-relational mapper from DataMapper to ActiveRecord
+  * Stored password hashes now include scheme prefixes, such as `{CRAM-MD5}` and `{PLAIN}`
 
 ## 0.1.4
- * Added "log" subcommand
+  * Added `log` subcommand
 
 ## 0.1.3
- * Added support for activation and deactivation of domains, admins, and accounts
- * Added "edit_admin" subcommand
+  * Added support for activation and deactivation of domains, admins, and accounts
+  * Added `edit_admin` subcommand
 
 ## 0.1.2
- * Added support for password hashing by doveadm (external subcommand)
- * Display active status
- * Hide passwords in list format
+  * Added support for password hashing by doveadm (external subcommand)
+  * Display active status
+  * Hide passwords in list format
 
 ## 0.1.1, released 2013-05-10
- * Fixed string length issue for passwords
+  * Fixed string length issue for passwords

data/README.md

@@ -35,6 +35,20 @@ Execute the `postfix_admin` command to generate your config file at `~/.postfix_
 Edit the file for your environment:
 
     $ vi ~/.postfix_admin.conf
+    ---
+    database: mysql2://postfix:password@localhost/postfix
+    aliases: 30
+    mailboxes: 30
+    maxquota: 100
+    scheme: CRAM-MD5
+
+The configuration file format is as follows:
+
+    database: mysql2://<username>:<password>@<host>/<database>
+    aliases: Default maximum number of aliases allowed per domain
+    mailboxes: Default maximum number of mailboxes allowed per domain
+    maxquota: Default maximum quota (in MB) allowed per mailbox for a domain
+    scheme: Default password scheme
 
 You can see the domains on your host if the `database` parameter is set properly:
 

data/Rakefile

@@ -2,6 +2,11 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 require "rspec/core/rake_task"
 
+require "bundler/setup"
+Bundler.require(:default, :development)
+require "postfix_admin"
+require "postfix_admin/cli"
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
@@ -22,3 +27,27 @@ task :setup_test_db do
   puts import_db_cmd
   puts `#{import_db_cmd}`
 end
+
+namespace :db do
+  desc "Loads the seed data from db/seeds.rb"
+  task :seed do
+    establish_db_connection
+    require_relative "db/seeds"
+  end
+
+  namespace :seed do
+    desc "Truncates tables of each database for current environment and loads the seeds"
+    task :replant do
+      establish_db_connection
+
+      require_relative "db/reset"
+      require_relative "db/seeds"
+    end
+  end
+
+  def establish_db_connection
+    FactoryBot.find_definitions
+
+    PostfixAdmin::CLI.new.db_setup
+  end
+end

data/db/reset.rb

@@ -0,0 +1,7 @@
+DomainAdmin.delete_all
+Mailbox.delete_all
+Alias.delete_all
+Domain.without_all.delete_all
+Admin.delete_all
+Quota2.delete_all
+Log.delete_all

data/db/seeds.rb

@@ -0,0 +1,26 @@
+include FactoryBot::Syntax::Methods
+
+create(:domain, domain: "example.com", description: "example.com Description")
+create(:domain, domain: "example.org", description: "example.org Description")
+
+all_admin = create(:admin, username: "all@example.com")
+all_admin.rel_domains << Domain.find('ALL')
+all_admin.superadmin = true if all_admin.has_superadmin_column?
+all_admin.save!
+
+admin = create(:admin, username: "admin@example.com")
+domain = Domain.find('example.com')
+domain.admins << admin
+domain.rel_aliases   << build(:alias, address: "alias@example.com")
+domain.rel_mailboxes << build(:mailbox, local_part: "user")
+domain.rel_mailboxes << build(:mailbox, local_part: "user2")
+domain.save!
+
+# forward
+user = Alias.find("user2@example.com").update(goto: "user2@example.com,forward@example.com")
+
+create(:quota2, username: "user@example.com", bytes: 75 * PostfixAdmin::KB_TO_MB)
+
+create(:log)
+create(:log, action: "delete_domain", data: "user@example.com")
+create(:log, domain: "example.org", data: "example.org")

data/docker-admin/config.local.php

@@ -16,9 +16,11 @@ $CONF['password_validation'] = array(
 
 $CONF['encrypt'] = 'dovecot:CRAM-MD5';
 
+$CONF['default_aliases'] = array();
 $CONF['domain_quota'] = 'NO';
 $CONF['quota'] = 'YES';
+$CONF['emailcheck_resolve_domain']='NO';
 
 // setup_password: 'password'
 $CONF['setup_password'] = '87745eb0269b2f42813b23601be3231a:6e41880f73d97321f2f0b25a5ee30f57f5ab3be8';
-?>
+?>

data/docker-compose.yml

@@ -1,10 +1,11 @@
 # docker compose up -d
 #
 # Run tests on service app
-# You may need to run tests on Docker because of its requirement of doveadm
+# You may need to run tests on Docker because of its requirement of `doveadm` command.
 # docker compose exec app bundle exec rake setup_test_db
-# docker compose exec app bundle exec rake test
 # docker compose exec app bundle exec rake spec
+#
+# rspec spec/runner_spec.rb
 
 services:
   app:
@@ -26,12 +27,6 @@ services:
       - ./docker-admin/config.local.php:/var/www/html/config.local.php
     depends_on:
       - db
-#    environment:
-#      - POSTFIXADMIN_DB_TYPE=mysqli
-#      - POSTFIXADMIN_DB_HOST=db
-#      - POSTFIXADMIN_DB_USER=postfix
-#      - POSTFIXADMIN_DB_PASSWORD=password
-#      - POSTFIXADMIN_DB_NAME=postfix
   db:
     image: mariadb:10
     ports:

data/lib/postfix_admin/base.rb

@@ -100,7 +100,7 @@ module PostfixAdmin
         domain: domain_name,
         password: password,
         name: name,
-        quota_mb: @config[:maxquota]
+        quota: @config[:maxquota] * KB_TO_MB
       }
 
       # An Alias also will be added when a Mailbox is saved.
@@ -121,13 +121,14 @@ module PostfixAdmin
       domain = find_domain(domain_name)
 
       attributes = {
-        local_part: local_part,
-        goto: goto
+        address: address,
+        goto: goto,
+        domain: domain_name
       }
 
-      domain.rel_aliases << Alias.new(attributes)
+      new_alias = Alias.new(attributes)
 
-      raise_save_error(domain) unless domain.save
+      raise_save_error(new_alias) unless new_alias.save
     end
 
     def delete_alias(address)
@@ -153,7 +154,7 @@ module PostfixAdmin
         raise_error "Domain has already been registered: #{domain_name}"
       end
 
-      new_description = description || domain_name
+      new_description = description || ""
 
       domain = Domain.new
       domain.attributes = {
@@ -174,18 +175,6 @@ module PostfixAdmin
       admin_names = domain.admins.map(&:username)
 
       domain.destroy!
-
-      # Remove admins who had the deleted domain only
-      admin_names.each do |name|
-        next unless Admin.exists?(name)
-
-        admin = Admin.find(name)
-
-        # check if the admin is needed or not
-        if admin.rel_domains.empty?
-          admin.destroy!
-        end
-      end
     end
 
     def delete_admin(user_name)
@@ -194,7 +183,6 @@ module PostfixAdmin
       end
 
       admin = Admin.find(user_name)
-      admin.rel_domains.delete_all
       admin.destroy!
     end
 
@@ -203,8 +191,8 @@ module PostfixAdmin
         raise_error "Could not find account: #{address}"
       end
 
-      Mailbox.where(username: address).delete_all
-      Alias.where(address: address).delete_all
+      mailbox = Mailbox.find(address)
+      mailbox.destroy!
     end
 
     private
@@ -219,7 +207,8 @@ module PostfixAdmin
     end
 
     def raise_save_error(obj)
-      raise_error "Failed to save #{obj.class}: #{obj.errors.full_messages.join(', ')}"
+      massage = obj.errors.full_messages.join(', ')
+      raise_error "Failed to save #{obj.class}: #{massage}"
     end
 
     def address_split(address)