mailmanager 1.0.14 → 1.0.15

data/.gitignore

@@ -3,3 +3,4 @@ pkg/mailmanager-*.gem
 html/*
 doc/*
 results/*
+mailman

data/Changelog

@@ -1,4 +1,10 @@
-Current version is 1.0.14
+Current version is 1.0.15
+
+changes since 1.0.14
+- added a Cucumber integration test suite
+- fixed a list creation bug when Mailman outputs to an aliases db directly
+- added a delete_list method
+- raise exception when attempting to create a mailing list that already exists
 
 changes since 1.0.13
 - more detailed error report when creating a new list fails

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailmanager (1.0.13)
+    mailmanager (1.0.15)
       json (~> 1.4.6)
       open4 (~> 1.0.1)
 
@@ -14,7 +14,15 @@ GEM
     ci_reporter (1.6.4)
       builder (>= 2.1.2)
     columnize (0.3.2)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
     diff-lcs (1.1.2)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
     json (1.4.6)
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
@@ -37,6 +45,7 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.4)
       archive-tar-minitar (>= 0.5.2)
+    term-ansicolor (1.0.5)
 
 PLATFORMS
   ruby
@@ -44,6 +53,7 @@ PLATFORMS
 DEPENDENCIES
   ZenTest (~> 4.4.2)
   ci_reporter
+  cucumber
   mailmanager!
   rspec (~> 2.4.0)
   ruby-debug19

data/README.rdoc

@@ -83,6 +83,25 @@ Exposing new list properties works something like this:
 That should get you started hacking on the gem. If you get stuck or are trying to
 do anything more complex, please feel free to e-mail me: cap10morgan@gmail.com.
 
+== Testing
+
+The RSpec suite should run out of the box with the 'rake spec' command.
+Feel free to open a GitHub issue if they do not.
+
+You'll need a local working installation of GNU Mailman 2.1.14 (or a later version
+of 2.1.x, probably) to run the Cucumber integration tests. Make a symlink to the
+root directory of your Mailman install in the mailmanager directory. It should be
+named "mailman". So if you are in the top-level mailmanager directory and your
+Mailman installation is in /usr/local/mailman, you would run this command:
+    ln -s /usr/local/mailman mailman
+
+Once that's done, you should be able to just run 'cucumber' in the top-level
+mailmanager directory.
+
+_MAKE SURE THIS IS NOT A MAILMAN INSTALLATION YOU CARE ABOUT!_ The Cucumber test
+suite will start by deleting all mailing lists so it can have a clean slate to
+test with.
+
 == Contributing
 
 - Fork on GitHub

data/config/cucumber.yml

@@ -0,0 +1,11 @@
+<%
+all_opts = "--color"
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = "#{all_opts} " + (rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}")
+std_opts = "#{all_opts} --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
+autotest: <%= rerun_opts %>
+autotest-all: <%= std_opts %>

data/features/create_list.feature

@@ -0,0 +1,18 @@
+Feature: Creating a new list
+  As a developer using MailManager
+  In order to create new mailing lists
+  I want MailManager to offer this feature
+
+  Background:
+    Given MailManager is initialized on "./mailman"
+
+  Scenario: Creating a new list
+    Given no lists exist
+    When I create a new list "foo"
+    Then I should have a list named "foo"
+
+  Scenario: Creating a list with the same name as an existing list
+    Given no lists exist
+    When I create a new list "foo"
+    Then it should raise MailManager::ListNameConflictError when I create a new list "foo"
+    And I should have 1 list

data/features/step_definitions/create_list_steps.rb

@@ -0,0 +1,4 @@
+When /^I create a new list "([^"]*)"$/ do |list_name|
+  @mailmanager.create_list(:name => list_name, :admin_email => 'cuke@foo.org', :admin_password => 'greenisgood')
+end
+

data/features/step_definitions/global_steps.rb

@@ -0,0 +1,24 @@
+Given /^MailManager is initialized on "([^\"]+)"$/ do |mailman_root|
+  @mailmanager = MailManager.init(mailman_root)
+end
+
+Given /^no lists exist$/ do
+  @mailmanager.list_names.each do |list_name|
+    @mailmanager.delete_list(list_name)
+  end
+end
+
+Then /^it should raise (.+?) when (.+)$/ do |exception,when_step|
+  lambda {
+    When when_step
+  }.should raise_error(eval(exception))
+end
+
+Then /^I should have (\d+) lists?$/ do |num|
+  @mailmanager.should have(num.to_i).lists
+end
+
+Then /^I should have a list named "([^"]*)"$/ do |list_name|
+  @mailmanager.list_names.should include(list_name)
+end
+

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', File.dirname(__FILE__))
+require "mailmanager"

data/lib/mailmanager/lib.rb

@@ -3,6 +3,12 @@ module MailManager
   class MailmanExecuteError < StandardError #:nodoc:
   end
 
+  class ListNotFoundError < StandardError #:nodoc:
+  end
+
+  class ListNameConflictError < StandardError #:nodoc:
+  end
+
   class Lib #:nodoc:all
 
     def mailmanager
@@ -15,8 +21,33 @@ module MailManager
       parse_output(cmd, out)
     end
 
+    def list_names
+      lists.map { |list| list.name }
+    end
+
     def create_list(params)
+      raise ArgumentError, "Missing :name param" if params[:name].nil?
+      list_name = params[:name]
+      raise ListNameConflictError, "List \"#{list_name}\" already exists" if list_names.include?(list_name)
       cmd = :newlist
+      # create the list
+      out = command(cmd, params)
+      # get the new list
+      begin
+        get_list(list_name)
+      rescue ListNotFoundError
+        raise MailmanExecuteError, "List creation failed: #{out}"
+      end
+    end
+
+    def get_list(list_name)
+      raise ListNotFoundError, "#{list_name} does not exist" unless list_names.include?(list_name)
+      MailManager::List.new(list_name)
+    end
+
+    def delete_list(params)
+      params = {:name => params} unless params.respond_to?(:has_key?)
+      cmd = :rmlist
       out = command(cmd, params)
       parse_output(cmd, out)
     end
@@ -141,7 +172,7 @@ module MailManager
       mailman_cmd = "#{mailmanager.root}/bin/#{cmd.to_s} "
       # delete opts as we handle them explicitly
       stdin = nil
-      stdin = opts.delete(:stdin) if opts.has_key?(:stdin)
+      stdin = opts.delete(:stdin) if opts.respond_to?(:has_key?) && opts.has_key?(:stdin)
       case cmd
       when :newlist
         mailman_cmd += "-q "
@@ -152,6 +183,9 @@ module MailManager
           escape(opts.delete(key))
         }.join(' ')
         mailman_cmd += "#{mailman_cmd_suffix} "
+      when :rmlist
+        raise ArgumentError, "Missing :name param" if opts[:name].nil?
+        mailman_cmd += "#{escape(opts.delete(:name))} "
       when :withlist
         raise ArgumentError, "Missing :name param" if opts[:name].nil?
         proxy_path = File.dirname(__FILE__)
@@ -211,6 +245,8 @@ module MailManager
         end
         raise MailmanExecuteError, "Error getting name of newly created list. Mailman sent:\n#{output}" if list_name.nil?
         return_obj = MailManager::List.new(list_name)
+      when :rmlist
+        return_obj = output =~ /Removing list info/
       when :list_lists
         lists = []
         puts "Output from Mailman:\n#{output}" if MailManager.debug

data/lib/mailmanager/list.rb

@@ -35,6 +35,15 @@ module MailManager
       lib.create_list(params)
     end
 
+    def self.delete(list_name) #:nodoc:
+      lib.delete_list(list_name)
+    end
+
+    # Deletes the list, but not the archives
+    def delete
+      self.class.delete(self.name)
+    end
+
     # Returns the list's email address
     def address
       result = lib.list_address(self)

data/lib/mailmanager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = '1.0.14'
+  VERSION = '1.0.15'
 end

data/lib/mailmanager.rb

@@ -82,7 +82,7 @@ module MailManager
     # Only retrieves the list names, doesn't wrap them in MailManager::List
     # instances.
     def list_names
-      lists.map { |list| list.name }
+      @lib.list_names
     end
 
     # Create a new list. Returns an instance of MailManager::List. Params are:
@@ -96,8 +96,11 @@ module MailManager
     # Get an existing list as a MailManager::List instance. Raises an exception if
     # the list doesn't exist.
     def get_list(list_name)
-      raise "#{list_name} list does not exist" unless list_names.include?(list_name.downcase)
-      MailManager::List.new(list_name)
+      @lib.get_list(list_name)
+    end
+
+    def delete_list(list_name)
+      MailManager::List.delete(list_name)
     end
   end
 

data/mailmanager.gemspec

@@ -27,4 +27,5 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('ZenTest', '~>4.4.2')
   s.add_development_dependency('ruby-debug19')
   s.add_development_dependency('ci_reporter')
+  s.add_development_dependency('cucumber')
 end

data/spec/lib/mailmanager/lib_spec.rb

@@ -5,6 +5,14 @@ describe MailManager::Lib do
   let(:subject)     { MailManager::Lib.new }
   let(:fake_root)   { '/foo/bar' }
   let(:process)     { mock(Process::Status) }
+  let(:list_result) { <<EOF
+3 matching mailing lists found:
+        Foo - [no description available]
+     BarBar - Dummy list
+    Mailman - Mailman site list
+EOF
+  }
+  let(:list_result_after_create) { list_result + "\n        Bar - [no description available]\n" }
 
   before :each do
     subject.stub(:mailmanager).and_return(mailmanager)
@@ -14,47 +22,48 @@ describe MailManager::Lib do
 
   describe "#lists" do
     it "should return all existing lists" do
-      list_result = <<EOF 
-3 matching mailing lists found:
-        Foo - [no description available]
-     BarBar - Dummy list
-    Mailman - Mailman site list
-EOF
       subject.stub(:run_command).with("#{fake_root}/bin/list_lists 2>&1", nil).
-        and_return([list_result,process])
+        and_return([list_result, process])
       subject.lists.should have(3).lists
     end
   end
 
   describe "#create_list" do
+    before :each do
+      subject.stub(:run_command).with("#{fake_root}/bin/list_lists 2>&1", nil).
+        and_return([list_result, process])
+    end
+
     it "should raise an argument error if list name is missing" do
       lambda {
         subject.create_list(:admin_email => 'foo@bar.baz', :admin_password => 'qux')
       }.should raise_error(ArgumentError)
     end
+
     it "should raise an argument error if list admin email is missing" do
       lambda {
-        subject.create_list(:name => 'foo', :admin_password => 'qux')
+        subject.create_list(:name => 'bar', :admin_password => 'qux')
       }.should raise_error(ArgumentError)
     end
+
     it "should raise an argument error if admin password is missing" do
       lambda {
-        subject.create_list(:name => 'foo', :admin_email => 'foo@bar.baz')
+        subject.create_list(:name => 'bar', :admin_email => 'foo@bar.baz')
       }.should raise_error(ArgumentError)
     end
 
     context "with valid list params" do
       let(:new_aliases) {
-        ['foo:              "|/foo/bar/mail/mailman post foo"',
-         'foo-admin:        "|/foo/bar/mail/mailman admin foo"',
-         'foo-bounces:      "|/foo/bar/mail/mailman bounces foo"',
-         'foo-confirm:      "|/foo/bar/mail/mailman confirm foo"',
-         'foo-join:         "|/foo/bar/mail/mailman join foo"',
-         'foo-leave:        "|/foo/bar/mail/mailman leave foo"',
-         'foo-owner:        "|/foo/bar/mail/mailman owner foo"',
-         'foo-request:      "|/foo/bar/mail/mailman request foo"',
-         'foo-subscribe:    "|/foo/bar/mail/mailman subscribe foo"',
-         'foo-unsubscribe:  "|/foo/bar/mail/mailman unsubscribe foo"']
+        ['bar:              "|/foo/bar/mail/mailman post bar"',
+         'bar-admin:        "|/foo/bar/mail/mailman admin bar"',
+         'bar-bounces:      "|/foo/bar/mail/mailman bounces bar"',
+         'bar-confirm:      "|/foo/bar/mail/mailman confirm bar"',
+         'bar-join:         "|/foo/bar/mail/mailman join bar"',
+         'bar-leave:        "|/foo/bar/mail/mailman leave bar"',
+         'bar-owner:        "|/foo/bar/mail/mailman owner bar"',
+         'bar-request:      "|/foo/bar/mail/mailman request bar"',
+         'bar-subscribe:    "|/foo/bar/mail/mailman subscribe bar"',
+         'bar-unsubscribe:  "|/foo/bar/mail/mailman unsubscribe bar"']
       }
       let(:new_list_return) {
         prefix =<<EOF
@@ -62,24 +71,55 @@ To finish creating your mailing list, you must edit your /etc/aliases (or
 equivalent) file by adding the following lines, and possibly running the                            
 `newaliases' program:                                                                               
                                                                                                     
-## foo mailing list                                                                                 
+## bar mailing list                                                                                 
 EOF
         prefix+new_aliases.join("\n")
       }
-      let(:fake_aliases_file) { mock(File) }
 
-      before :each do
-        File.stub(:open).with('/etc/aliases', 'a').and_return(fake_aliases_file)
-        subject.stub(:run_newaliases_command)
+      it "should create the list" do
+        subject.should_receive(:run_command).
+          with("#{fake_root}/bin/newlist -q \"bar\" \"foo@bar.baz\" \"qux\" 2>&1", nil).
+          and_return([new_list_return, process])
+        subject.should_receive(:run_command).
+          with("#{fake_root}/bin/list_lists 2>&1", nil).
+          and_return([list_result, process], [list_result_after_create, process])
+        subject.create_list(:name => 'bar', :admin_email => 'foo@bar.baz',
+                            :admin_password => 'qux')
       end
 
-      it "should create the list" do
+      it "should not rely on the aliases setup output" do
+        # https://www.pivotaltracker.com/story/show/9422507
+        subject.should_receive(:run_command).
+          with("#{fake_root}/bin/newlist -q \"bar\" \"foo@bar.baz\" \"qux\" 2>&1", nil).
+          and_return(["", process])
         subject.should_receive(:run_command).
-          with("#{fake_root}/bin/newlist -q \"foo\" \"foo@bar.baz\" \"qux\" 2>&1", nil).
-          and_return([new_list_return,process])
-        subject.create_list(:name => 'foo', :admin_email => 'foo@bar.baz',
+          with("#{fake_root}/bin/list_lists 2>&1", nil).
+          and_return([list_result, process], [list_result_after_create, process])
+        subject.create_list(:name => 'bar', :admin_email => 'foo@bar.baz',
                             :admin_password => 'qux')
       end
+
+      it "should raise an exception if the list already exists" do
+        # https://www.pivotaltracker.com/story/show/9421449
+        subject.should_not_receive(:run_command).
+          with("#{fake_root}/bin/newlist -q \"foo\" \"foo@bar.baz\" \"qux\" 2>&1", nil)
+        subject.should_receive(:run_command).
+          with("#{fake_root}/bin/list_lists 2>&1", nil).
+          and_return([list_result, process])
+        lambda {
+          subject.create_list(:name => 'foo', :admin_email => 'foo@bar.baz',
+                              :admin_password => 'qux')
+        }.should raise_error(MailManager::ListNameConflictError)
+      end
+    end
+  end
+
+  describe "#delete_list" do
+    it "should delete the list" do
+      subject.should_receive(:run_command).
+        with("#{fake_root}/bin/rmlist \"foo\" 2>&1", nil).
+        and_return(["Removing list info", process])
+      subject.delete_list('foo')
     end
   end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 14
-  version: 1.0.14
+  - 15
+  version: 1.0.15
 platform: ruby
 authors: 
 - Wes Morgan
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 -05:00
+date: 2011-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,6 +103,19 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Ruby wrapper library for GNU Mailman's admin functions
 email: MorganW@dnc.org
 executables: []
@@ -121,6 +134,11 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- config/cucumber.yml
+- features/create_list.feature
+- features/step_definitions/create_list_steps.rb
+- features/step_definitions/global_steps.rb
+- features/support/env.rb
 - lib/mailmanager.rb
 - lib/mailmanager/lib.rb
 - lib/mailmanager/list.rb