mediawiki-testwiki 0.0.1

data/lib/media_wiki/test_wiki/docker_helper.rb

@@ -0,0 +1,83 @@
+#--
+###############################################################################
+#                                                                             #
+# mediawiki-testwiki -- MediaWiki test wiki based on Docker                   #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# mediawiki-testwiki is free software; you can redistribute it and/or modify  #
+# it under the terms of the GNU Affero General Public License as published by #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# mediawiki-testwiki is distributed in the hope that it will be useful, but   #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with mediawiki-testwiki. If not, see <http://www.gnu.org/licenses/>.  #
+#                                                                             #
+###############################################################################
+#++
+
+require 'docker_helper'
+
+require_relative 'config'
+
+module MediaWiki
+
+  module TestWiki
+
+    module DockerHelper
+
+      include ::DockerHelper
+
+      def self.docker(silent = false, &block)
+        ::DockerHelper::Proxy.new.extend(self).tap { |docker|
+          docker.extend(SilentDocker) if silent
+          Config.enhance(docker, &block)
+        }
+      end
+
+      def docker_container_name(setup = false)
+        parts = [config.registry_repo, config.version]
+        parts << :setup if setup
+        parts.join('-')
+      end
+
+      def docker_image_name(setup = false)
+        base = "#{config.registry_repo}:#{config.version}"
+        setup ? "#{base}-setup" : "#{config.registry_user}/#{base}"
+      end
+
+      def docker_build(image = nil)
+        super(config.build_path, image)
+      end
+
+      def docker_volume(name = nil)
+        super(config.volume, name)
+      end
+
+      def docker_url(*args)
+        args.size > 1 ? super : super(config.port, *args)
+      end
+
+      module SilentDocker
+
+        def docker_system(*args, &block)
+          options = args.last.is_a?(Hash) ? args.pop : {}
+          options[:out] = options[:err] = :close
+          super(*args << options, &block)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/media_wiki/test_wiki/docker_pool.rb

@@ -0,0 +1,48 @@
+#--
+###############################################################################
+#                                                                             #
+# mediawiki-testwiki -- MediaWiki test wiki based on Docker                   #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# mediawiki-testwiki is free software; you can redistribute it and/or modify  #
+# it under the terms of the GNU Affero General Public License as published by #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# mediawiki-testwiki is distributed in the hope that it will be useful, but   #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with mediawiki-testwiki. If not, see <http://www.gnu.org/licenses/>.  #
+#                                                                             #
+###############################################################################
+#++
+
+require_relative 'docker_helper'
+
+module MediaWiki
+
+  module TestWiki
+
+    class DockerPool < ::DockerHelper::Pool
+
+      DEFAULT_BASENAME = 'mediawiki-testwiki'
+
+      def initialize(size = nil, basename = nil, silent = false, &block)
+        super(size, basename, DockerHelper.docker(silent, &block)) {
+          self.image, self.port, self.path =
+            docker.image_name, docker.config.port, docker.config.endpoint
+        }
+      end
+
+    end
+
+  end
+
+end

data/lib/media_wiki/test_wiki/rake_helper.rb

@@ -0,0 +1,217 @@
+#--
+###############################################################################
+#                                                                             #
+# mediawiki-testwiki -- MediaWiki test wiki based on Docker                   #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# mediawiki-testwiki is free software; you can redistribute it and/or modify  #
+# it under the terms of the GNU Affero General Public License as published by #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# mediawiki-testwiki is distributed in the hope that it will be useful, but   #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with mediawiki-testwiki. If not, see <http://www.gnu.org/licenses/>.  #
+#                                                                             #
+###############################################################################
+#++
+
+require_relative 'docker_helper'
+
+module MediaWiki
+
+  module TestWiki
+
+    module RakeHelper
+
+      include DockerHelper
+
+      class << self
+
+        def extended(base)
+          keep = [:noop, :verbose]
+
+          base.define_singleton_method(:docker_system) { |*args, &block|
+            options = !args.last.is_a?(Hash) ? {} :
+              args.pop.keep_if { |k,| keep.include?(k) }
+
+            sh(*args << options, &block)
+          }
+
+          configure(base) unless base.respond_to?(:config)
+        end
+
+        def configure(base, load_tasks = false, &block)
+          Config.enhance(base, &block).tap {
+            require_relative 'rake_tasks' if load_tasks
+          }
+        end
+
+      end
+
+      def docker_tasks(name, image)
+        %w[start stop restart clean clobber].each { |task|
+          task(task) { send("docker_#{task}", name, image) }
+        }
+
+        task(:start) { puts "#{name}: #{docker_url(name)}" }
+      end
+
+      def file_size(*args)
+        file_create(*args) { |t| File.write(t.name, '') }.instance_eval {
+          def needed?; !File.size?(name); end
+          yield self if block_given?
+          self
+        }
+      end
+
+      def fix_config(file, host)
+        File.write(file, File.read(file).tap { |content|
+          content.sub!(/^\$wgServer\b/, '#\&')
+          content.gsub!(host, 'localhost')
+        })
+      end
+
+      def setup_broken(arg)
+        msg = <<-EOT
+
+*** Manual configuration is broken for this MediaWiki version. ***
+
+        EOT
+
+        if arg.is_a?(LoadError)
+          abort msg << <<-EOT
+However, automatic configuration is not available: #{arg}.
+Please install the `mechanize' gem and try again.
+          EOT
+        elsif arg
+          wait msg << <<-EOT
+Also, automatic configuration is not supported for this version either.
+Please create a valid configuration file and press enter when finished:
+#{arg}
+          EOT
+        else
+          abort msg << <<-EOT
+However, you have requested to skip automatic configuration.
+Please unset `NOMECHANIZE' and try again.
+          EOT
+        end
+      end
+
+      def setup_manual(url, dir, cfg, err = nil, unk = nil)
+        msg = <<-EOT
+
+Visit #{url} and configure the wiki:
+        EOT
+
+        msg << <<-EOT if unk
+
+NOTE: These configuration instructions have not been verified for
+      this version of MediaWiki -- please use your own judgement!
+        EOT
+
+        msg << <<-EOT
+
+  - Language
+    - Continue
+
+  - Welcome to MediaWiki!
+    - Continue
+
+  - Connect to database
+    - Database type: SQLite
+    - SQLite data directory: #{dir}
+    - Database name: #{config.database_name}
+    - Continue
+
+  - Name
+    - Name of wiki: #{config.sitename}
+    - Your username: #{config.username}
+    - Password: #{config.password}
+    - Password again: #{config.password}
+    - I'm bored already, just install the wiki.
+    - Continue
+
+  - Install (1)
+    - Continue
+
+  - Install (2)
+    - Continue
+
+Save #{File.basename(cfg)} (replace existing file if already present):
+#{cfg}
+
+Close configuration window and press enter when finished.
+        EOT
+
+        msg << <<-EOT if err
+
+NOTE: Install the `mechanize' gem to automate this process. (#{err})
+        EOT
+
+        wait(msg)
+      end
+
+      def setup_mechanize(url, dir, cfg)
+        agent = Mechanize.new
+        page  = agent.get(url)
+
+        continue = lambda { |&block|
+          form = page.forms.first
+          block[form] if block
+          page = agent.submit(form)
+        }
+
+        2.times { continue.() }
+
+        continue.() { |form|
+          form.sqlite_wgSQLiteDataDir = dir
+          form.sqlite_wgDBname = config.database_name
+          form.radiobuttons_with(value: 'sqlite').first.check
+        }
+
+        continue.() { |form|
+          form.radiobuttons_with(value: 'skip').first.check
+
+          form.config_wgSitename = config.sitename
+          form.config__AdminName = config.username
+
+          form.config__AdminPassword  = config.password
+          form.config__AdminPassword2 = config.password
+        }
+
+        2.times { continue.() }
+
+        page.link_with(text: Regexp.new(
+          Regexp.escape(File.basename(cfg)))).click.save!(cfg)
+      end
+
+      def verified_version?(strict = false, list = config.verified_versions)
+        strict ? list.include?(config.version) :
+          list.grep(/\A#{Regexp.escape(config.version[/.*\./])}/).any?
+      end
+
+      def broken_version?(strict = false)
+        verified_version?(strict, config.broken_versions)
+      end
+
+      private
+
+      def wait(msg)
+        puts(msg)
+        $stdin.gets
+      end
+
+    end
+
+  end
+
+end

data/lib/media_wiki/test_wiki/rake_tasks.rb

@@ -0,0 +1,32 @@
+#--
+###############################################################################
+#                                                                             #
+# mediawiki-testwiki -- MediaWiki test wiki based on Docker                   #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# mediawiki-testwiki is free software; you can redistribute it and/or modify  #
+# it under the terms of the GNU Affero General Public License as published by #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# mediawiki-testwiki is distributed in the hope that it will be useful, but   #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with mediawiki-testwiki. If not, see <http://www.gnu.org/licenses/>.  #
+#                                                                             #
+###############################################################################
+#++
+
+require_relative 'rake_helper'
+
+extend MediaWiki::TestWiki::RakeHelper
+
+%w[main files setup docker].each { |task|
+  load "media_wiki/test_wiki/tasks/#{task}.rake" }

data/lib/media_wiki/test_wiki/rspec_adapter.rb

@@ -0,0 +1,101 @@
+#--
+###############################################################################
+#                                                                             #
+# mediawiki-testwiki -- MediaWiki test wiki based on Docker                   #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# mediawiki-testwiki is free software; you can redistribute it and/or modify  #
+# it under the terms of the GNU Affero General Public License as published by #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# mediawiki-testwiki is distributed in the hope that it will be useful, but   #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with mediawiki-testwiki. If not, see <http://www.gnu.org/licenses/>.  #
+#                                                                             #
+###############################################################################
+#++
+
+require_relative 'docker_pool'
+
+module MediaWiki
+
+  module TestWiki
+
+    module RSpecAdapter
+
+      Proxy = Struct.new(:version, :config, :pool)
+
+      PROXY_NAME = :live_media_wiki
+
+      class << self
+
+        def enhance(config, *args)
+          return if config.respond_to?(PROXY_NAME)
+          init_config(Proxy.new, config, *args)
+          config
+        end
+
+        def extended(base)
+          init_proxy(RSpec.configuration.send(PROXY_NAME), base.metadata)
+          base
+        end
+
+        private
+
+        def init_config(mw, config, *args)
+          config.add_setting PROXY_NAME, default: mw
+
+          config.after   :context, *args do mw.pool.clean end
+          config.extend  self,     *args
+          config.include Helpers,  *args
+
+          config.filter_run_excluding required_version: lambda { |value|
+            version = mw.version and not
+              Gem::Requirement.new(Array(value)).satisfied_by?(version)
+          }
+        end
+
+        def init_proxy(mw, options = {})
+          version, size = options.values_at(:version, :pool_size)
+
+          mw.pool = DockerPool.new(size, nil, true) { |config|
+            mw.version = Gem::Version.new(config.version = version) if version
+            mw.config = { username: config.username, password: config.password }
+          }
+        end
+
+      end
+
+      module Helpers
+
+        def live_media_wiki_gateway(*args)
+          described_class.new(@live_media_wiki_url, *args).tap { |gateway|
+            yield gateway if block_given?
+          }
+        end
+
+        def live_media_wiki_reset(*args, &block)
+          mw = RSpec.configuration.send(PROXY_NAME)
+
+          @live_media_wiki_url = mw.pool.fetch_url
+
+          mw.config.values_at(:username, :password)
+            .unshift(live_media_wiki_gateway(*args, &block))
+        end
+
+      end
+
+    end
+
+  end
+
+end