postfix_admin 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70bd18f454fd77684ab652949e36829f6d9e3e8e275e475819b60b025b3fea6e
-  data.tar.gz: 477da494d685bcaeb45f090d92edbfb1abc6af811e04172a4e4f1865b51eac46
+  metadata.gz: a9877c43c00661c60c1fee5e200211c97cd4cdc8d53593985c3e49f8296d27b9
+  data.tar.gz: 9d9744f09e0a9e3ccdc72af138a4879824f3cd00bc3a1a111d0320a30007ee84
 SHA512:
-  metadata.gz: a7b8c5f69e4f15589ca5c10250e88d9dfb76e623bed02548161e24c29fca02e74e97b154bf5f876936922e7b7d134f4fb6f46ab2e85765198fbaf5c7dddb1c32
-  data.tar.gz: 777b1af93896c8df8a4eab31af493af872a694502cab871c0ea99bcf7e8a82ce014228e82b117c37a3c9953ec86bd54648a01954c2bcae72c373fca94d1c18dc
+  metadata.gz: 86dfd30f6793fd6c13d09e532d7499f2e040dbe654f1bf86299d79b518a96906b6e208fd87c9bbda631d577ccfe39fb08f910e9cc41617be00425c84860d03f2
+  data.tar.gz: f553b648aefc912877d3bcc149258a1d529caa457827f24b04bc4c5d4b45d7fc1397c4189c56ba0e800360320b6295b92abbde0ff344dc56d764995d8d88c448

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Install dovecotpw
+        run: sudo apt-get install -y dovecot-core
+      - name: Copy configure file
+        run: cp ./spec/misc/postfix_admin.conf ~/.postfix_admin.conf
+      - name: Copy my.cnf (for `rake setup_test_db`)
+        run: cp ./spec/misc/ci.my.cnf ~/.my.cnf
+      - name: docker-compose up
+        run: docker-compose up -d db
+      - name: Sleep (work around)
+        # wait-for-it.sh doesn't work with docker compose port mapping
+        run: sleep 10
+      - name: Set up test database
+        run: bundle exec rake setup_test_db
+      - name: Run specs
+        run: bundle exec rake spec

data/.gitignore

@@ -17,3 +17,5 @@ test/version_tmp
 tmp
 .idea
 .vagrant
+.ruby-version
+.rspec_status

data/.rubocop.yml

@@ -1,2 +1,22 @@
+AllCops:
+  NewCops: enable
 Style/StringLiterals:
   Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Style/EmptyElse:
+  EnforcedStyle: empty

data/CHANGELOG.md

@@ -1,22 +1,36 @@
+# CHANGELOG
+
+## 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
+
 ## 0.2.1
- * Supported `superadmin` column of `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 its object-relational mapper from DataMapper to ActiveRecord
- * Stored password hash includes scheme prefix: like `{CRAM-MD5}`, `{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
- * Support for activation and deactivation of domain, admin and account
- * Added "edit_admin" subcommand
+  * Added support for activation and deactivation of domains, admins, and accounts
+  * Added `edit_admin` subcommand
 
 ## 0.1.2
- * Support password hash by doveadm (external subcommand)
- * Show active status
- * Don't show passwords using list format
+  * Added support for password hashing by doveadm (external subcommand)
+  * Display active status
+  * Hide passwords in list format
 
-## 0.1.1, release 2013-05-10
- * Fixed string length of password
+## 0.1.1, released 2013-05-10
+  * Fixed string length issue for passwords

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in postfix_admin.gemspec
 gemspec

data/LICENSE

@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -10,19 +10,25 @@ Command Line Tools for Postfix Admin
   + Web Site http://postfixadmin.sourceforge.net/
   + GitHub https://github.com/postfixadmin/postfixadmin
 
-* Postfix Admin 3.2 is supported.
+* Supports Postfix Admin 3.2
 
-* MySQL/MariaDB is supported.
+* Supports MySQL/MariaDB
 
-* Other database engines are not supported.
+* Other database engines are not supported
+
+## Requirements
+
+* Ruby 2.6 or higher
+* MySQL/MariaDB
+* Dovecot (required for setting passwords using the `doveadm pw` subcommand)
 
 ## Installation
 
-Install postfix_admin as:
+Install `postfix_admin` using:
 
     $ gem install postfix_admin
 
-Just execute `postfix_admin` command to generate your config file: `~/.postfix_admin.conf`
+Execute the `postfix_admin` command to generate your config file at `~/.postfix_admin.conf`:
 
     $ postfix_admin
 
@@ -30,40 +36,40 @@ Edit the file for your environment:
 
     $ vi ~/.postfix_admin.conf
 
-You can see domains on your host if the `database` parameter is set properly:
+You can see the domains on your host if the `database` parameter is set properly:
 
     $ postfix_admin show
 
 ## Usage
 
-List the postfix_admin subcommands as:
+List the `postfix_admin` subcommands with:
 
     $ postfix_admin
 
 ```
 Commands:
-  postfix_admin account_passwd user@example.com new_password               # Change password of account
-  postfix_admin add_account user@example.com password                      # Add an account
-  postfix_admin add_admin admin@example.com password                       # Add an admin user
-  postfix_admin add_admin_domain admin@example.com example.com             # Add admin_domain
-  postfix_admin add_alias alias@example.com goto@example.net               # Add an alias
-  postfix_admin add_domain example.com                                     # Add a domain
-  postfix_admin admin_passwd admin@example.com new_password                # Change password of admin
+  postfix_admin account_passwd user@example.com new_password               # Change the password of an account
+  postfix_admin add_account user@example.com password                      # Add a new account
+  postfix_admin add_admin admin@example.com password                       # Add a new admin user
+  postfix_admin add_admin_domain admin@example.com example.com             # Grant an admin user access to a specific domain
+  postfix_admin add_alias alias@example.com goto@example.net               # Add a new alias
+  postfix_admin add_domain example.com                                     # Add a new domain
+  postfix_admin admin_passwd admin@example.com new_password                # Change the password of an admin user
   postfix_admin delete_account user@example.com                            # Delete an account
-  postfix_admin delete_admin admin@example.com                             # Delete an admin
-  postfix_admin delete_admin_domain admin@example.com example.com          # Delete admin_domain
+  postfix_admin delete_admin admin@example.com                             # Delete an admin user
+  postfix_admin delete_admin_domain admin@example.com example.com          # Revoke an admin user's access to a specific domain
   postfix_admin delete_alias alias@example.com                             # Delete an alias
   postfix_admin delete_domain example.com                                  # Delete a domain
   postfix_admin dump                                                       # Dump all data
   postfix_admin edit_account user@example.com                              # Edit an account
   postfix_admin edit_admin admin@example.com                               # Edit an admin user
   postfix_admin edit_alias alias@example.com                               # Edit an alias
-  postfix_admin edit_domain example.com                                    # Edit a domain limitation
+  postfix_admin edit_domain example.com                                    # Edit a domain
   postfix_admin help [COMMAND]                                             # Describe available commands or one specific command
-  postfix_admin log                                                        # Show action logs
+  postfix_admin log                                                        # Display action logs
   postfix_admin schemes                                                    # List all supported password schemes
-  postfix_admin setup example.com password                                 # Setup a domain
-  postfix_admin show [example.com | admin@example.com | user@example.com]  # Show domains or admins or mailboxes
+  postfix_admin setup example.com password                                 # Set up a domain
+  postfix_admin show [example.com | admin@example.com | user@example.com]  # Display details about domains, admins, or accounts
   postfix_admin summary [example.com]                                      # Summarize the usage of PostfixAdmin
   postfix_admin version                                                    # Show postfix_admin version
 ```

data/Rakefile

@@ -1,6 +1,53 @@
 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"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :test
+
+desc "Set up test database"
+task :setup_test_db do
+  create_db_cmd = "mysql -e 'CREATE DATABASE `postfix_test`;'"
+  puts create_db_cmd
+  puts `#{create_db_cmd}`
+
+  import_db_cmd = "mysql postfix_test < docker-db/postfix.v1841.sql"
+  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/bin/console

@@ -1,16 +1,20 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+Bundler.require(:default, :development)
 require "postfix_admin"
 require "postfix_admin/cli"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-cli = PostfixAdmin::CLI.new
-cli.db_setup
+@cli = PostfixAdmin::CLI.new
+@cli.db_setup
 include PostfixAdmin
 
+include FactoryBot::Syntax::Methods
+FactoryBot.find_definitions
+
 require "pry"
 Pry.start
 

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,6 +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-app/Dockerfile

@@ -9,7 +9,7 @@ WORKDIR /app
 COPY Gemfile postfix_admin.gemspec ./
 COPY ./lib/postfix_admin/version.rb ./lib/postfix_admin/version.rb
 
-RUN gem install bundler && bundle install
+RUN gem install bundler -v 2.4.22 && bundle install
 
 COPY spec/postfix_admin.conf /root/.postfix_admin.conf
 COPY docker-app/my.cnf /root/.my.cnf
@@ -18,8 +18,4 @@ COPY docker-app/my.cnf /root/.my.cnf
 RUN curl https://raw.githubusercontent.com/vishnubob/wait-for-it/master/wait-for-it.sh -so /wait-for-it.sh && \
     chmod 755 /wait-for-it.sh
 
-COPY docker-app/docker-entrypoint.sh /docker-entrypoint.sh
-RUN chmod +x /docker-entrypoint.sh
-ENTRYPOINT ["/docker-entrypoint.sh"]
-
-CMD ["irb"]
+CMD ["irb"]

data/docker-app/my.cnf

@@ -1,5 +1,5 @@
 [client]
-user = postfix
-password = password
+user = root
+password = ScRgkaMz4YwHN5dyxfQj
 host = db
 database = postfix

data/docker-compose.yml

@@ -1,4 +1,12 @@
-version: '3.8'
+# docker compose up -d
+#
+# Run tests on service app
+# 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:
@@ -6,17 +14,10 @@ services:
       context: .
       dockerfile: docker-app/Dockerfile
     tty: true
-    volumes:
-    - .:/app
-    depends_on:
-      - db
-  app2.5:
-    tty: true
-    build:
-      context: .
-      dockerfile: docker-app-2.5/Dockerfile
     volumes:
       - .:/app
+    environment:
+      - DATABASE_URL=mysql2://postfix:password@db/postfix
     depends_on:
       - db
   admin:
@@ -27,20 +28,19 @@ 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:
+      - "13306:3306"
     volumes:
-    - ./docker-db/postfix.v1841.sql:/docker-entrypoint-initdb.d/postfix.sql
-#    - ./docker-db/postfix.v740.sql:/docker-entrypoint-initdb.d/postfix.sql
-#    - ./docker-db/postfix.v352.sql:/docker-entrypoint-initdb.d/postfix.sql
+      - db-data:/var/lib/mysql
+      - ./docker-db/postfix.v1841.sql:/docker-entrypoint-initdb.d/postfix.sql
+#      - ./docker-db/postfix.v740.sql:/docker-entrypoint-initdb.d/postfix.sql
+#      - ./docker-db/postfix.v352.sql:/docker-entrypoint-initdb.d/postfix.sql
     environment:
-      - MYSQL_RANDOM_ROOT_PASSWORD=yes
+      - MYSQL_ROOT_PASSWORD=ScRgkaMz4YwHN5dyxfQj
       - MYSQL_USER=postfix
       - MYSQL_PASSWORD=password
       - MYSQL_DATABASE=postfix
+volumes:
+  db-data: