sappho-data-publisher 0.1.7 → 0.1.8

data/lib/sappho-data-publisher/atlassian_app.rb

@@ -0,0 +1,56 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require 'sappho-data-publisher/modules'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class AtlassianApp
+
+        def initialize
+          @appName = self.class.name.split("::").last
+          @appServer = nil
+          @loggedIn = false
+        end
+
+        def connect
+          raise "you have already attempted to connect to #{@appName}" if @appServer or @loggedIn
+          modules = Modules.instance
+          @config = modules.get :configuration
+          @logger = modules.get :logger
+          url = @config.data["#{@appName.downcase}.url"]
+          mock = "mock#{@appName}"
+          @appServer = modules.set?(mock) ? modules.get(mock).mockInstance(url) : yield(url)
+          @token = @appServer.login @config.data["#{@appName.downcase}.username"], @config.data["#{@appName.downcase}.password"]
+          @logger.info "logged into #{@appName} #{url}"
+          @loggedIn = true
+        end
+
+        def shutdown
+          if loggedIn?
+            @appServer.logout @token
+            @logger.info "logged out of #{@appName}"
+          end
+          @loggedIn = false
+          @appServer = nil
+        end
+
+        def loggedIn?
+          @appServer and @loggedIn
+        end
+
+        private
+
+        def checkLoggedIn
+          raise "you are not logged in to #{@appName}" unless loggedIn?
+        end
+
+      end
+
+    end
+  end
+end

data/lib/sappho-data-publisher/configuration.rb

@@ -14,10 +14,10 @@ module Sappho
 
         attr_reader :data
 
-        def initialize
-          filename = File.expand_path(ARGV[0] || 'config.yml')
+        def initialize filename = ARGV[0]
+          filename = File.expand_path(filename || 'config.yml')
           @data = YAML.load_file filename
-          Modules.instance.get(:logger).warn "configuration loaded from #{filename}"
+          Modules.instance.get(:logger).info "configuration loaded from #{filename}"
         end
 
       end

data/lib/sappho-data-publisher/confluence.rb

@@ -3,28 +3,24 @@
 # See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
-require 'sappho-data-publisher/modules'
+require 'sappho-data-publisher/atlassian_app'
 require 'xmlrpc/client'
 
 module Sappho
   module Data
     module Publisher
 
-      class Confluence
+      class Confluence < AtlassianApp
 
-        def initialize
-          @config = Modules.instance.get :configuration
-          @logger = Modules.instance.get :logger
-          url = @config.data['confluence.url']
-          @wiki = XMLRPC::Client.new2("#{url}/rpc/xmlrpc").proxy('confluence1')
-          @token = @wiki.login @config.data['confluence.username'], @config.data['confluence.password']
-          @logger.info "Confluence #{url} is online"
+        def connect
+          super do |url|
+            XMLRPC::Client.new2("#{url}/rpc/xmlrpc").proxy('confluence1')
+          end
         end
 
         def getGlobalConfiguration
           pageName = @config.data['confluence.global.config.page.name']
-          return getPage @config.data['confluence.config.space.key'], pageName if pageName
-          ''
+          pageName ? getPage(@config.data['confluence.config.space.key'], pageName) : ''
         end
 
         def getConfiguration
@@ -36,39 +32,36 @@ module Sappho
         end
 
         def getScript rawPage
-          rawPage.scan(/\{noformat.*?\}(.*?)\{noformat\}/m).each { |pageData| yield pageData[0] }
+          rawPage.scan(/^\{noformat.*?\}(.*?)^\{noformat\}/m).each { |pageData| yield pageData[0] }
         end
 
         def publish content, pageData, parameters
           setPage parameters['space'], parameters['parent'], pageData['pagename'], content
         end
 
-        def shutdown
-          @wiki.logout @token
-          @logger.info 'disconnected from Confluence'
-        end
-
         private
 
         def getPage spaceKey, pageName
+          checkLoggedIn
           @logger.info "reading wiki page #{spaceKey}:#{pageName}"
-          @wiki.getPage(@token, spaceKey, pageName)['content']
+          @appServer.getPage(@token, spaceKey, pageName)['content']
         end
 
         def setPage spaceKey, parentPageName, pageName, content
+          checkLoggedIn
           begin
-            page = @wiki.getPage(@token, spaceKey, pageName)
+            page = @appServer.getPage(@token, spaceKey, pageName)
             page['content'] = content
             @logger.info "rewriting existing wiki page #{spaceKey}:#{pageName}"
           rescue
             page = {
               'space' => spaceKey,
-              'parentId' => @wiki.getPage(@token, spaceKey, parentPageName)['id'],
+              'parentId' => @appServer.getPage(@token, spaceKey, parentPageName)['id'],
               'title' => pageName,
               'content' => content }
             @logger.info "creating new wiki page #{spaceKey}:#{pageName} as child of #{parentPageName}"
           end
-          @wiki.storePage @token, page
+          @appServer.storePage @token, page
         end
 
       end

data/lib/sappho-data-publisher/custom_liquid.rb

@@ -24,10 +24,12 @@ module Sappho
 
           def fullname username
             begin
-              Modules.instance.get('AddressBook').getUserFullName(username)
+              name = Modules.instance.get('AddressBook').getUserFullName(username)
+              raise 'unknown person' unless name and name.length > 0
             rescue
-              '** John Doe **'
+              name = '** John Doe **'
             end
+            name
           end
 
         end

data/lib/sappho-data-publisher/jira.rb

@@ -3,60 +3,55 @@
 # See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
-require 'sappho-data-publisher/modules'
+require 'sappho-data-publisher/atlassian_app'
 require 'soap/wsdlDriver'
 
 module Sappho
   module Data
     module Publisher
 
-      class Jira
+      class Jira < AtlassianApp
 
-        def initialize
-          config = Modules.instance.get :configuration
-          @logger = Modules.instance.get :logger
-          url = config.data['jira.url']
-          @jira = SOAP::WSDLDriverFactory.new("#{url}/rpc/soap/jirasoapservice-v2?wsdl").create_rpc_driver
-          @token = @jira.login config.data['jira.username'], config.data['jira.password']
-          @allCustomFields = @jira.getCustomFields @token
-          @logger.info "Jira #{url} is online"
+        def connect
+          super do |url|
+            SOAP::WSDLDriverFactory.new("#{url}/rpc/soap/jirasoapservice-v2?wsdl").create_rpc_driver
+          end
+          @allCustomFields = @appServer.getCustomFields @token
           @users = {}
         end
 
         def gatherData pageData, parameters
+          checkLoggedIn
           id = parameters['id']
           @logger.info "reading Jira issue #{id}"
-          issue = @jira.getIssue @token, id
+          issue = @appServer.getIssue @token, id
           pageData['summary'] = summary = issue['summary']
           pageData['pagename'] = summary unless pageData['pagename']
           pageData['description'] = issue['description']
-          pageData['customFields'] = customFields = {}
+          pageData['cf'] = customFields = {}
           @allCustomFields.each { |customField|
-            customFields[customField['id']] = {
-                'name' => customField['name'],
-                'values' => nil
-            }
+            customFields[cfname customField['id']] = { 'name' => customField['name'] }
           }
           issue['customFieldValues'].each { |customFieldValue|
-            customFields[customFieldValue['customfieldId']]['values'] = customFieldValue['values']
+            customFields[cfname customFieldValue['customfieldId']]['values'] =
+                customFieldValue['values']
           }
         end
 
         def getUserFullName username
+          checkLoggedIn
           user = @users[username]
           unless user
             @logger.info "reading Jira user details for #{username}"
-            @users[username] = user = @jira.getUser(@token, username)
+            @users[username] = user = @appServer.getUser(@token, username)
           end
           user['fullname']
         end
 
-        def shutdown
-          if @jira
-            @jira.logout @token
-            @jira = nil
-            @logger.info 'disconnected from Jira'
-          end
+        private
+
+        def cfname name
+          name.sub /customfield_/, ''
         end
 
       end

data/lib/sappho-data-publisher/modules.rb

@@ -25,6 +25,10 @@ module Sappho
           @modules[name]
         end
 
+        def set? name
+          @modules.has_key? name
+        end
+
         def shutdown
           each { |mod| mod.shutdown }
         end

data/lib/sappho-data-publisher/version.rb

@@ -7,7 +7,7 @@ module Sappho
   module Data
     module Publisher
       NAME = 'sappho-data-publisher'
-      VERSION = '0.1.7'
+      VERSION = '0.1.8'
       AUTHORS = ['Andrew Heald']
       EMAILS = ['andrew@heald.co.uk']
       HOMEPAGE = 'https://github.com/sappho/sappho-data-publisher/wiki'

data/lib/sappho-data-publisher.rb

@@ -27,9 +27,13 @@ module Sappho
           modules = Modules.instance
           modules.set :logger, logger
           modules.set :configuration, Configuration.new
-          modules.set 'Jira', (jira = Jira.new)
+          jira = Jira.new
+          jira.connect
+          modules.set 'Jira', jira
           modules.set 'AddressBook', jira
-          modules.set 'Confluence', Confluence.new
+          confluence = Confluence.new
+          confluence.connect
+          modules.set 'Confluence', confluence
           CustomLiquid.setup
           Publisher.new.publish
           modules.shutdown

data/test/config/config.yml

@@ -0,0 +1,10 @@
+config.module: Confluence
+confluence.url: https://wiki.example.com
+confluence.username: wikiuser
+confluence.password: secretwikipassword
+confluence.config.space.key: MYSPACE
+confluence.global.config.page.name: Global Macros
+confluence.config.page.name: Page Specification
+jira.url: https://jira.example.com
+jira.username: jiraadminuser
+jira.password: secretjirapassword

data/test/data/config.yml

@@ -0,0 +1,5 @@
+places:
+  London:
+    country: England
+  Paris:
+    country: France

data/test/data/confluence-chunk.input

@@ -0,0 +1,41 @@
+This is ignored.
+So is this.
+{noformat}
+This is not ignored.
+
+And the above blank line should be included.
+
+
+
+And the above blank lines, and below, should be included.
+
+
+{noformat}
+
+Try a one-liner.
+{noformat}This one-liner is not ignored.
+{noformat}
+
+Try another one-liner.
+{noformat}This one-liner is not ignored.{noformat} <- the trailing {noformat} will be included because it isn't at column 1.
+{noformat}
+
+This is ignored.
+{noformat:nopanel=true}
+This is not ignored, either.
+ {noformat} <- And this line should be included.
+{noformat}
+{noformat xx}
+It does not matter about extra invalid stuff on the opening {noformat}.
+{noformat}
+
+Test for an invalid closing {noformat}.
+{noformat}
+Invalid closing: Line 1
+{noformatx}
+Invalid closing: Line 2
+{noformat}
+
+Finally, test what happens when a chunk is left open.
+{noformat}
+This will not end up in a chunk!

data/test/data/confluence-chunk.output

@@ -0,0 +1,21 @@
+----
+This is not ignored.
+
+And the above blank line should be included.
+
+
+
+And the above blank lines, and below, should be included.
+
+
+----This one-liner is not ignored.
+----This one-liner is not ignored.{noformat} <- the trailing {noformat} will be included because it isn't at column 1.
+----
+This is not ignored, either.
+ {noformat} <- And this line should be included.
+----
+It does not matter about extra invalid stuff on the opening {noformat}.
+----
+Invalid closing: Line 1
+{noformatx}
+Invalid closing: Line 2

data/test/data/confluence-pages/page-op-tests/MYSPACE/Global Macros.wiki

@@ -0,0 +1 @@
+Global macros go here.

data/test/data/confluence-pages/page-op-tests/MYSPACE/Home.wiki

@@ -0,0 +1 @@
+Home Page.

data/test/data/confluence-pages/page-op-tests/MYSPACE/Page Specification.wiki

@@ -0,0 +1 @@
+Page specification goes here.

data/test/data/confluence-pages/page-op-tests/MYSPACE/Template.wiki

@@ -0,0 +1 @@
+This is a template.

data/test/data/custom-liquid.content

@@ -0,0 +1,6 @@
+User with username cgrant is Cary Grant.
+User with username nobody is ** John Doe **.
+nothing
+
+blank
+The answer to the ultimate question of life, the universe, and everything, is 42.

data/test/data/custom-liquid.template

@@ -0,0 +1,10 @@
+{% squash nothing %}User with username cgrant is {{ 'cgrant' | fullname }}.{% endsquash %}
+User with username nobody is {{ 'nobody' | fullname }}.
+{% squash nothing%}{% endsquash %}
+{% empty %}
+This stuff will be disposed of.
+{% assign answer = 42 %}
+The above assign should be executed, however, even though nothing will be output here.
+{% endempty %}
+{% squash blank%}     {% endsquash %}
+The answer to the ultimate question of life, the universe, and everything, is {{ answer }}.

data/test/data/jira-results.yml

@@ -0,0 +1,22 @@
+# Expected result sets used by Jira tests to verify results
+# See http://yaml.org/spec for syntax help
+
+TEST-42-A:
+  summary: Testing 123
+  pagename: Testing 123
+  description: This is a test.
+  cf:
+    !str 10500: { name: Service }
+    !str 10501: { name: Type, values: [ Business Process ] }
+    !str 10502: { name: Invoice Number }
+    !str 10503: { name: Customer, values: [ Bank of England ] }
+
+TEST-42-B:
+  summary: Testing 123
+  pagename: Test Page
+  description: This is a test.
+  cf:
+    !str 10500: { name: Service }
+    !str 10501: { name: Type, values: [ Business Process ] }
+    !str 10502: { name: Invoice Number }
+    !str 10503: { name: Customer, values: [ Bank of England ] }

data/test/data/jira.yml

@@ -0,0 +1,23 @@
+# Data injected into mock Jira when Jira and custom Liquid tests run
+# See http://yaml.org/spec for syntax help
+
+users:
+
+  cgrant:   { fullname: Cary Grant }
+  bholiday: { fullname: Billie Holiday }
+
+issues:
+
+  TEST-42:
+    summary: Testing 123
+    description: This is a test.
+    customFieldValues:
+      - { customfieldId: customfield_10501, values: [ Business Process ] }
+      - { customfieldId: customfield_10503, values: [ Bank of England ] }
+
+all_custom_fields:
+
+  - { id: customfield_10500, name: Service }
+  - { id: customfield_10501, name: Type }
+  - { id: customfield_10502, name: Invoice Number }
+  - { id: customfield_10503, name: Customer }

data/test/ruby/confluence_test.rb

@@ -0,0 +1,75 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require 'helper'
+
+class ConfluenceTest < Test::Unit::TestCase
+
+  def setup
+    setupLogging
+    setupConfiguration
+    setupConfluence 'Confluence'
+    @mockConfluence.setScenario 'page-op-tests'
+  end
+
+  def teardown
+    assert @confluence.loggedIn?, 'Confluence should be logged in before shutdown'
+    super
+    assert !@confluence.loggedIn?, 'Confluence should not be logged in after shutdown'
+  end
+
+  def connect
+    assert !@confluence.loggedIn?, 'Confluence should not be logged in before connecting'
+    @confluence.connect
+    assert @confluence.loggedIn?, 'Confluence should be logged in after connecting'
+  end
+
+  def test_get_global_config
+    connect
+    assert_equal 'Global macros go here.', @confluence.getGlobalConfiguration
+  end
+
+  def test_get_config
+    connect
+    assert_equal 'Page specification goes here.', @confluence.getConfiguration
+  end
+
+  def test_get_template
+    connect
+    assert_equal 'This is a template.',
+                 @confluence.getTemplate({}, {
+                     'templatespace' => 'MYSPACE',
+                     'templatepage' => 'Template'})
+  end
+
+  def test_publish_page
+    connect
+    spaceKey = 'MYSPACE'
+    pageName = 'Generated Page'
+    pageData = {
+        'pagename' => pageName
+    }
+    params = {
+        'space' => spaceKey,
+        'parent' => 'Home'
+    }
+    content = 'New page content.'
+    @confluence.publish content, pageData, params
+    @mockConfluence.assert_page_content spaceKey, pageName, content
+    content = 'Updated page content.'
+    @confluence.publish content, pageData, params
+    @mockConfluence.assert_page_content spaceKey, pageName, content
+  end
+
+  def test_config_chunking
+    connect # not actually needed but keeps teardown happy
+    output = ''
+    @confluence.getScript File.open(testFilename('data/confluence-chunk.input'), 'rb').read do |chunk|
+      output += '----' + chunk
+    end
+    assert_equal File.open(testFilename('data/confluence-chunk.output'), 'rb').read, output
+  end
+
+end

data/test/ruby/custom_liquid_test.rb

@@ -0,0 +1,28 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require 'rubygems'
+gem 'liquid', '>= 2.3.0'
+require 'liquid'
+require 'sappho-data-publisher/custom_liquid'
+require 'helper'
+
+class CustomLiquidTest < Test::Unit::TestCase
+
+  def setup
+    setupLogging
+    setupConfiguration
+    setupJira 'AddressBook'
+    @jira.connect
+    Sappho::Data::Publisher::CustomLiquid.setup
+  end
+
+  def test_page_generation
+    template = File.open(testFilename('data/custom-liquid.template'), 'rb').read
+    assert_equal File.open(testFilename('data/custom-liquid.content'), 'rb').read,
+                 Liquid::Template.parse(template).render
+  end
+
+end

data/test/ruby/helper.rb

@@ -0,0 +1,51 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require "test/unit"
+require 'logger'
+require 'yaml'
+require 'sappho-data-publisher/modules'
+require 'sappho-data-publisher/configuration'
+require 'sappho-data-publisher/jira'
+require 'sappho-data-publisher/confluence'
+require 'mock_jira'
+require 'mock_confluence'
+
+class Test::Unit::TestCase
+
+  def setupLogging
+    @logger = Logger.new STDOUT
+    @logger.level = Logger::DEBUG
+    Sappho::Data::Publisher::Modules.instance.set :logger, @logger
+  end
+
+  def setupConfiguration (filename = testFilename('config/config.yml'))
+    config = Sappho::Data::Publisher::Configuration.new filename
+    Sappho::Data::Publisher::Modules.instance.set :configuration, config
+  end
+
+  def setupJira (moduleName, dataFilename = testFilename('data/jira.yml'))
+    @mockJira = MockJira.new dataFilename
+    Sappho::Data::Publisher::Modules.instance.set 'mockJira', @mockJira
+    @jira = Sappho::Data::Publisher::Jira.new
+    Sappho::Data::Publisher::Modules.instance.set moduleName, @jira
+  end
+
+  def setupConfluence moduleName
+    @mockConfluence = MockConfluence.new
+    Sappho::Data::Publisher::Modules.instance.set 'mockConfluence', @mockConfluence
+    @confluence = Sappho::Data::Publisher::Confluence.new
+    Sappho::Data::Publisher::Modules.instance.set moduleName, @confluence
+  end
+
+  def teardown
+    Sappho::Data::Publisher::Modules.instance.shutdown
+  end
+
+  def testFilename filename
+    "#{File.dirname(__FILE__)}/../#{filename}"
+  end
+
+end

data/test/ruby/jira_test.rb

@@ -0,0 +1,105 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require 'helper'
+
+class JiraTest < Test::Unit::TestCase
+
+  def setup
+    setupLogging
+    setupConfiguration
+    setupJira 'Jira'
+    @expectedResults = YAML.load_file testFilename 'data/jira-results.yml'
+  end
+
+  def teardown
+    assert @jira.loggedIn?, 'Jira should be logged in before shutdown'
+    super
+    assert !@jira.loggedIn?, 'Jira should not be logged in after shutdown'
+  end
+
+  def connect
+    assert !@jira.loggedIn?, 'Jira should not be logged in before connecting'
+    @jira.connect
+    assert @jira.loggedIn?, 'Jira should be logged in after connecting'
+  end
+
+  def test_get_user_full_name
+    @getUserCount = 0
+    # check a valid name but before connecting to Jira
+    @username = 'cgrant'
+    @fullName = 'Cary Grant'
+    assert_full_name_failure
+    # now connect to allow the test to proceed
+    connect
+    # check a valid name
+    assert_full_name
+    # test name caching
+    assert_full_name 0
+    # this won't be cached
+    @username = 'bholiday'
+    @fullName = 'Billie Holiday'
+    assert_full_name
+    # check an invalid name
+    @username = 'nobody'
+    assert_full_name_failure
+    # check an invalid name - there should be no caching
+    assert_full_name_failure
+    assert_get_user_count 2
+    # check a valid name again
+    @username = 'cgrant'
+    @fullName = 'Cary Grant'
+    assert_full_name 0
+  end
+
+  def test_data_gathering_pagename_as_summary
+    # pagename will be a copy of the issue summary
+    assert_data_gathered({}, { 'id' => 'TEST-42' }, 'TEST-42-A')
+  end
+
+  def test_data_gathering_pagename_as_supplied
+    # pagename supplied already so should not be set by data gatherer
+    assert_data_gathered({ 'pagename' => 'Test Page' }, { 'id' => 'TEST-42' }, 'TEST-42-B')
+  end
+
+  def test_data_gathering_from_invalid_issue
+    assert_raise RuntimeError do
+      assert_data_gathered({}, { 'id' => 'TEST-999' }, nil)
+    end
+  end
+
+  def test_data_gathering_without_connecting
+    assert_raise RuntimeError do
+      # this would be okay if connected, but we're not
+      assert_data_gathered({}, { 'id' => 'TEST-42' }, 'TEST-42-A', true)
+    end
+    # keep the teardown happy by connecting anyway
+    connect
+  end
+
+  def assert_data_gathered pageData, parameters, expectedResults, noConnect = false
+    connect unless noConnect
+    @jira.gatherData pageData, parameters
+    assert_equal @expectedResults[expectedResults], pageData
+  end
+
+  def assert_full_name inc = 1
+    assert_equal @fullName, @jira.getUserFullName(@username),
+                 "Incorrect full name obtained for user #{@username}"
+    assert_get_user_count inc
+  end
+
+  def assert_get_user_count inc
+    assert_equal (@getUserCount += inc), @mockJira.getUserCount,
+                 'Incorrect number of calls to Jira\'s getUser function'
+  end
+
+  def assert_full_name_failure
+    assert_raise RuntimeError do
+      assert_full_name
+    end
+  end
+
+end

data/test/ruby/mock_atlassian_app.rb

@@ -0,0 +1,50 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+class MockAtlassianApp
+
+  def initialize expectedUrl, expectedUsername, expectedPassword
+    @expectedUrl = expectedUrl
+    @expectedUsername = expectedUsername
+    @expectedPassword = expectedPassword
+    @token = 'a-token-string'
+    @loggedIn = false
+  end
+
+  def mockInstance url
+    check_not_logged_in
+    assert_expected 'URL', url, @expectedUrl
+    self
+  end
+
+  def login username, password
+    check_not_logged_in
+    assert_expected 'username', username, @expectedUsername
+    assert_expected 'password', password, @expectedPassword
+    @loggedIn = true
+    @token
+  end
+
+  def logout token
+    assert_token_valid token
+    @loggedIn = false
+  end
+
+  private
+
+  def check_not_logged_in
+    raise 'you should not be logged in yet but you are' if @loggedIn
+  end
+
+  def assert_expected description, actual, expected
+    raise "expected #{description} of #{expected} but got #{actual}" unless actual == expected
+  end
+
+  def assert_token_valid token
+    raise 'you should be logged in by now but you are not' unless @loggedIn
+    assert_expected 'token', token, @token
+  end
+
+end

data/test/ruby/mock_confluence.rb

@@ -0,0 +1,46 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require 'mock_atlassian_app'
+
+class MockConfluence < MockAtlassianApp
+
+  attr_reader :getUserCount
+
+  def initialize
+    super 'https://wiki.example.com', 'wikiuser', 'secretwikipassword'
+  end
+
+  def setScenario scenario
+    @scenario = scenario
+    @pageCache = {}
+  end
+
+  def getPage token, spaceKey, pageName
+    assert_token_valid token
+    space = @pageCache[spaceKey]
+    @pageCache[spaceKey] = space = {} unless space
+    content = space[pageName]
+    unless content
+      space[pageName] = content =
+          File.open("#{File.dirname(__FILE__)}/../data/confluence-pages/#{@scenario}/#{spaceKey}/#{pageName}.wiki", 'rb').read
+    end
+    {
+        'space' => spaceKey,
+        'title' => pageName,
+        'content' => content
+    }
+  end
+
+  def storePage token, page
+    assert_token_valid token
+    @pageCache[page['space']][page['title']] = page['content']
+  end
+
+  def assert_page_content spaceKey, pageName, expectedContent
+    raise 'page content is not as expected' unless @pageCache[spaceKey][pageName] == expectedContent
+  end
+
+end

data/test/ruby/mock_jira.rb

@@ -0,0 +1,39 @@
+# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
+# This software is licensed under the GNU Affero General Public License, version 3.
+# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# Copyright 2012 Andrew Heald.
+
+require 'mock_atlassian_app'
+
+class MockJira < MockAtlassianApp
+
+  attr_reader :getUserCount
+
+  def initialize filename
+    super 'https://jira.example.com', 'jiraadminuser', 'secretjirapassword'
+    data = YAML.load_file filename
+    @users = data['users']
+    @issues = data['issues']
+    @allCustomFields = data['all_custom_fields']
+    @getUserCount = 0
+  end
+
+  def getCustomFields token
+    assert_token_valid token
+    @allCustomFields
+  end
+
+  def getIssue token, id
+    assert_token_valid token
+    raise 'issue does not exist' unless @issues.has_key? id
+    @issues[id]
+  end
+
+  def getUser token, username
+    assert_token_valid token
+    @getUserCount += 1
+    raise 'user unknown' unless @users.has_key? username
+    @users[username]
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sappho-data-publisher
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Andrew Heald
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-01 00:00:00 Z
+date: 2012-03-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 
 files: 
 - bin/sappho-data-publisher
+- lib/sappho-data-publisher/atlassian_app.rb
 - lib/sappho-data-publisher/configuration.rb
 - lib/sappho-data-publisher/confluence.rb
 - lib/sappho-data-publisher/custom_liquid.rb
@@ -69,6 +70,25 @@ files:
 - lib/sappho-data-publisher/publisher.rb
 - lib/sappho-data-publisher/version.rb
 - lib/sappho-data-publisher.rb
+- test/config/config.yml
+- test/data/config.yml
+- test/data/confluence-chunk.input
+- test/data/confluence-chunk.output
+- test/data/confluence-pages/page-op-tests/MYSPACE/Global Macros.wiki
+- test/data/confluence-pages/page-op-tests/MYSPACE/Home.wiki
+- test/data/confluence-pages/page-op-tests/MYSPACE/Page Specification.wiki
+- test/data/confluence-pages/page-op-tests/MYSPACE/Template.wiki
+- test/data/custom-liquid.content
+- test/data/custom-liquid.template
+- test/data/jira-results.yml
+- test/data/jira.yml
+- test/ruby/confluence_test.rb
+- test/ruby/custom_liquid_test.rb
+- test/ruby/helper.rb
+- test/ruby/jira_test.rb
+- test/ruby/mock_atlassian_app.rb
+- test/ruby/mock_confluence.rb
+- test/ruby/mock_jira.rb
 homepage: https://github.com/sappho/sappho-data-publisher/wiki
 licenses: []
 
@@ -102,5 +122,23 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Publishes aggregated data to formatted pages on a wiki
-test_files: []
-
+test_files: 
+- test/config/config.yml
+- test/data/config.yml
+- test/data/confluence-chunk.input
+- test/data/confluence-chunk.output
+- test/data/confluence-pages/page-op-tests/MYSPACE/Global Macros.wiki
+- test/data/confluence-pages/page-op-tests/MYSPACE/Home.wiki
+- test/data/confluence-pages/page-op-tests/MYSPACE/Page Specification.wiki
+- test/data/confluence-pages/page-op-tests/MYSPACE/Template.wiki
+- test/data/custom-liquid.content
+- test/data/custom-liquid.template
+- test/data/jira-results.yml
+- test/data/jira.yml
+- test/ruby/confluence_test.rb
+- test/ruby/custom_liquid_test.rb
+- test/ruby/helper.rb
+- test/ruby/jira_test.rb
+- test/ruby/mock_atlassian_app.rb
+- test/ruby/mock_confluence.rb
+- test/ruby/mock_jira.rb