activeldap 0.10.0 → 1.0.0

data/test-unit-ext/README.en

@@ -0,0 +1,247 @@
+# -*- rd -*-
+
+= README
+
+== Name
+
+TestUnitExt
+
+== What's this?
+
+TestUnitExt extends the standard Test::Unit.
+
+TestUnitExt provides some useful features:
+
+  * Emacs friendly backtrace format.
+  * runs tests depending on priority.
+  * supports attributes for each test.
+  * always shows tests result even if tests are interrupted.
+  * colorized output.
+  * outputs diff between expected and actual value.
+  * reports test result as XML format.
+  * adds pending/omission/notification methods.
+
+== Author
+
+Kouhei Sutou <kou@cozmixng.org>
+
+== Licence
+
+Ruby's.
+
+# == Mailing list
+#
+# None. needed?
+
+== Reference manual
+
+((<URL:http://test-unit-ext.rubyforge.org/doc/>))
+
+== Dependency libraries
+
+None
+
+== Usage
+
+  require 'test-unit-ext'
+
+== Reference
+
+=== Attributes
+
+You can add attributes to your test to get more useful
+information on failure. For example, you can add Bug ID like
+the following
+
+  class MyTest < Test::Unit::TestCase
+    bug 123
+    def test_invalid_input
+      assert_equal("OK", input)
+    end
+  end
+
+In the above example, test_invalid_input test has an
+attribute that the test is for Bug #123.
+
+You can also write like the following:
+
+  class MyTest < Test::Unit::TestCase
+    attribute :bug, 123
+    def test_invalid_input
+      assert_equal("OK", input)
+    end
+  end
+
+That is, bug method is a convenience method. You can add any
+attributes to your test if you use attribute method.
+
+=== Priority
+
+It will be difficult that you drop into test and develop
+cycle when you have many tests and the tests take much
+time. To reduce the problem, you can select some tests from
+all tests and reduce elapsed time each test. It's a problem
+that which tests are selected in each test.
+
+In TestUnitExt, each test has its priority and runs tests
+are selected by probabilistic method. --priority command
+line option enables this feature.
+
+A test that has higher priority will be ran in higher
+ratio. Each test doesn't run all tests but tests that are
+ran each test are changed in each test. All tests will be
+ran after some test and develop cycles.
+
+Tests that aren't succeeded in the previous test are ran in
+the current test in spite of its priority. This means that
+important tests are ran without you do something. You will
+keep your lightweight test and develop cycles without
+additional works.
+
+Here are a sample priority specification. Priority
+specification effects followed tests like public and
+private.
+
+  class MyTest < Test::Unit::TestCase
+    priority :must
+    def test_must
+      # will be always ran
+    end
+
+    def test_must2
+      # will be always ran too
+    end
+
+    priority :import
+    def test_import
+      # will be almost ran
+    end
+
+    priority :high
+    def test_high
+      # will be ran in high probability
+    end
+
+    priority :normal
+    def test_normal
+      # will be ran in fifty-fifty probability
+      # tests without priority specification has normal priority
+    end
+
+    priority :low
+    def test_low
+      # will be sometimes ran
+    end
+
+    priority :never
+    def test_never
+      # never be ran
+    end
+  end
+
+=== Pending
+
+You may write a test for a function that is not
+implemented. In the case, the test will be failed. It's
+correct that the test is failed but the test means 'the
+function is not implemented'. To state your intent, pend
+method is provided.
+
+Please state your intent by your test code by using the
+method.
+
+  class MyTest < Test::Unit::TestCase
+    def test_minor_function
+      pend("Should implement")
+      assert_equal("Good!", MyModule.minor_function)
+    end
+  end
+
+=== Omission
+
+You may write a test only for a special environment. In the
+case, the test will not work on a standard environment and you
+know that before you run the test. You will omit the test on
+a standard environment. To state your intent, omit method is
+provided.
+
+Please state your intent by your test code by using the method.
+
+  class MyTest < Test::Unit::TestCase
+    def test_special_function
+      omit("Only for special environment") unless MyModule.special_environment?
+      assert_equal("Good!", MyModule.special_function)
+    end
+  end
+
+
+=== Notification
+
+You may put some messages in test. For example, "this test
+is omitted because XXX module is not found on the
+environment."
+
+Those messages can be displayed by puts but it causes test
+result output. To prevent this, notify method is
+provided. notify method doesn't display those messages in
+the place but display those messages in test result summary
+like "failure", "error" and so on. You can leave those
+messages without breaking test result output by using notify
+method.
+
+  class MyTest < Test::Unit::TestCase
+    def test_with_other_module
+      unless MyModule.have_XXX?
+         notify("XXX module isn't found. skip this test.")
+         return
+      end
+      assert_equal("XXX Module!!!", MyModule.use_XXX)
+    end
+  end
+
+=== XML report
+
+Test result can be reported as XML format if --xml-report
+option is specified. A reported XML has the following
+structure:
+
+  <report>
+    <result>
+      <test-case>
+        <name>TEST CASE NAME</name>
+        <description>DESCRIPTION OF TEST CASE (if exists)</description>
+      </test-case>
+      <test>
+        <name>TEST NAME</name>
+        <description>DESCRIPTION OF TEST CASE (if exists)</description>
+        <option><!-- ATTRIBUTE INFORMATION (if exists) -->
+          <name>ATTRIBUTE NAME (e.g.: bug)</name>
+          <value>ATTRIBUTE VALUE (e.g.: 1234)</value>
+        </option>
+        <option>
+          ...
+        </option>
+      </test>
+      <status>TEST RESULT ([success|failure|error|pending|notification])</status>
+      <detail>DETAIL OF TEST RESULT (if exists)</detail>
+      <backtrace><!-- BACKTRACE (if exists) -->
+        <entry>
+          <file>FILE NAME</file>
+          <line>LINE</line>
+          <info>ADDITIONAL INFORMATION</info>
+        </entry>
+        <entry>
+          ...
+        </entry>
+      </backtrace>
+      <elapsed>ELAPSED TIME (e.g.: 0.000010)</elapsed>
+    </result>
+    <result>
+      ...
+    </result>
+    ...
+  </report>
+
+== Thanks
+
+  * ...

data/test-unit-ext/README.ja

@@ -0,0 +1,246 @@
+# -*- rd -*-
+
+= README.ja
+
+== 名前
+
+TestUnitExt
+
+== なにこれ？
+
+TestUnitExtはRuby標準のTest::Unitを拡張します。
+
+TestUnitExtはいくつかの有用な機能を提供します。
+
+  * Emacsにやさしいバックトレースフォーマット
+  * 優先度に応じたテストの実行
+  * 各テストへの属性の付加
+  * テストを途中終了（Ctrl+C）しても結果を表示
+  * 色付き出力
+  * テスト結果のdiff出力
+  * テスト結果のXMLでの出力
+  * 保留(pending)・省略(omission)・通知(notification)用メソッドの追加
+
+== 作者
+
+Kouhei Sutou <kou@cozmixng.org>
+
+== ライセンス
+
+Ruby's.
+
+# == メーリングリスト
+#
+# なし。必要？
+
+== リファレンスマニュアル
+
+((<URL:http://test-unit-ext.rubyforge.org/doc/>))
+
+== 依存ライブラリ
+
+なし
+
+== 使用法
+
+  require 'test-unit-ext'
+
+== リファレンス
+
+=== 属性
+
+テストに属性を加えて、テスト失敗時により有益な情報を利用する
+ことができます。例えば、以下のようにテストにBug IDの情報を付
+加することができます。
+
+  class MyTest < Test::Unit::TestCase
+    bug 123
+    def test_invalid_input
+      assert_equal("OK", input)
+    end
+  end
+
+この例では、test_invalid_inputテストがBug #123のテストである
+という情報を付加しています。
+
+これは以下のように書くこともできます。
+
+  class MyTest < Test::Unit::TestCase
+    attribute :bug, 123
+    def test_invalid_input
+      assert_equal("OK", input)
+    end
+  end
+
+つまり、bugメソッドは便利のために用意されたメソッドです。
+attributeメソッドを使うことで任意の属性を付加することができ
+ます。
+
+=== 優先度
+
+テストが多くなるとテスト時間が長くなり、テストと開発をリズム
+良く繰り返すことが難しくなります。それを軽減するために、開発
+時のテストでは毎回全てのテストを実行するのではなく、一部のテ
+ストのみ実行して1回のテスト時間を短くすることができます。問題
+は各テストでどのテストを実行するかです。
+
+TestUnitExtでは属性としてテストに優先度を付け、それに従って毎
+回実行するテストを確率的に選択します。コマンドラインオプショ
+ンで--priorityを指定するとこの機能が有効になります。
+
+優先度が高いテスト程高い確率で実行され、そうではないテストは
+低い頻度で実行されます。各テストでは全てのテストは実行しない
+が、各テストで実行するテストがその都度変わるため、何度も走ら
+せることにより結果的にテスト全体を実行することになります。
+
+また、前回成功しなかったテストは確実に実行するため、明示的に
+優先度を上げなくても失敗している（現在注目すべき重要な）テス
+トは毎回必ず実行します。これにより、プログラマの負荷をあげる
+ことなくテストのメリットを受けたまま、テストと開発のリズムを
+保つことができます。
+
+優先度は以下のように指定します。優先度指定はpublicやprivateの
+ように、以降のメソッド定義に影響します。
+
+  class MyTest < Test::Unit::TestCase
+    priority :must
+    def test_must
+      # 必ず実行
+    end
+
+    def test_must2
+      # これも必ず実行
+    end
+
+    priority :import
+    def test_import
+      # 高い確率で実行
+    end
+
+    priority :high
+    def test_high
+      # やや高い確率で実行
+    end
+
+    priority :normal
+    def test_normal
+      # 半々の確率で実行
+      # 優先度を指定していないときはnormal
+    end
+
+    priority :low
+    def test_low
+      # たまに実行
+    end
+
+    priority :never
+    def test_never
+      # 実行しない
+    end
+  end
+
+=== 保留
+
+現在はまだ実装していない機能をテストとして書く場合もあります。
+その場合、まだ実装していない機能のテストは失敗します。たしか
+にテストは失敗なのですが、そのテストは「実装が間違っている」
+ではなく、「まだ実装していない」を意図しています。これを明示
+的に表現するために新しくpendというメソッドを用意しています。
+
+「現在はまだ実装していない」という場合はこのメソッドを使って、
+その意図をコードで表現してください。
+
+  class MyTest < Test::Unit::TestCase
+    def test_minor_function
+      pend("Should implement")
+      assert_equal("Good!", MyModule.minor_function)
+    end
+  end
+
+=== 省略
+
+特定の環境でしか動作しないテストを書く場合もあります。その場
+合、特定の環境以外ではそのテストは失敗します。この場合はその
+テストは特定の環境以外では失敗することがわかっています。その
+ため、特定の環境以外ではそのテストは省略します。これを明示的
+に表現するために新しくomitというメソッドを用意しています。
+
+「このテストは省略する」という場合はこのメソッドを使って、そ
+の意図をコードで表現してください。
+
+  class MyTest < Test::Unit::TestCase
+    def test_special_function
+      omit("Only for special environment") unless MyModule.special_environment?
+      assert_equal("Good!", MyModule.special_function)
+    end
+  end
+
+=== 通知
+
+テスト中で何らかのメッセージを残したいことがあります。例えば、
+「この環境では○○モジュールがないからこのテストは省略しま
+す」、という場合です。
+
+それらのメッセージをputsで表示することもできますが、テスト結
+果の表示が乱れてしまいます。これを防ぐために、新しくnotifyメ
+ソッドを用意しています。notifyを使うとメッセージはその場では
+表示されず、テスト終了後に他の「失敗」や「エラー」などと同じ
+ように表示されます。これにより、テスト結果の表示を乱さずにメッ
+セージを残すことができます。
+
+  class MyTest < Test::Unit::TestCase
+    def test_with_other_module
+      unless MyModule.have_XXX?
+         notify("XXX module isn't found. skip this test.")
+         return
+      end
+      assert_equal("XXX Module!!!", MyModule.use_XXX)
+    end
+  end
+
+=== XML出力
+
+--xml-reportオプションを指定することでテスト結果をXML形式で出
+力することができます。出力されるXMLは以下のような構造になって
+います。
+
+  <report>
+    <result>
+      <test-case>
+        <name>テストケース名</name>
+        <description>テストケースの説明（もしあれば）</description>
+      </test-case>
+      <test>
+        <name>テスト名</name>
+        <description>テストの説明（もしあれば）</description>
+        <option><!-- 属性情報（もしあれば） -->
+          <name>属性名（例: bug）</name>
+          <value>属性値（例: 1234）</value>
+        </option>
+        <option>
+          ...
+        </option>
+      </test>
+      <status>テスト結果（[success|failure|error|pending|notification]）</status>
+      <detail>テスト結果の詳細（もしあれば）</detail>
+      <backtrace><!-- バックトレース（もしあれば） -->
+        <entry>
+          <file>ファイル名</file>
+          <line>行</line>
+          <info>付加情報</info>
+        </entry>
+        <entry>
+          ...
+        </entry>
+      </backtrace>
+      <elapsed>実行時間（例: 0.000010）</elapsed>
+    </result>
+    <result>
+      ...
+    </result>
+    ...
+  </report>
+
+== 感謝
+
+  * ...

data/test-unit-ext/Rakefile

@@ -0,0 +1,111 @@
+# -*- mode: ruby; coding: utf-8 -*-
+
+require 'English'
+
+require 'find'
+require 'fileutils'
+require 'rubygems'
+require 'hoe'
+
+base_dir = File.join(File.dirname(__FILE__))
+truncate_base_dir = Proc.new do |x|
+  x.gsub(/^#{Regexp.escape(base_dir + File::SEPARATOR)}/, '')
+end
+
+lib_dir = File.join(base_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir)
+
+require 'test-unit-ext'
+
+Test::Unit.run = true
+
+manifest = File.join(base_dir, "Manifest.txt")
+manifest_contents = []
+base_dir_included_components = %w(NEWS.en NEWS.ja README.en README.ja Rakefile)
+excluded_components = %w(.svn .test-result pkg)
+excluded_suffixes = %w(.png .ps .pdf .o .so .txt)
+Find.find(base_dir) do |target|
+  target = truncate_base_dir[target]
+  components = target.split(File::SEPARATOR)
+  if components.size == 1 and !File.directory?(target)
+    next unless base_dir_included_components.include?(components[0])
+  end
+  Find.prune if (excluded_components - components) != excluded_components
+  next if excluded_suffixes.include?(File.extname(target))
+  manifest_contents << target if File.file?(target)
+end
+
+dummy_files = %w(History.txt README.txt)
+FileUtils.touch("History.txt")
+FileUtils.cp("README.en", "README.txt")
+
+File.open(manifest, "w") do |f|
+  f.puts manifest_contents.sort.join("\n")
+end
+at_exit do
+  FileUtils.rm_f(manifest)
+  FileUtils.rm_f(dummy_files)
+end
+
+def cleanup_white_space(entry)
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+version = TestUnitExt::VERSION
+ENV["VERSION"] = version
+project = Hoe.new('test-unit-ext', version) do |project|
+  project.rubyforge_name = 'test-unit-ext'
+  project.remote_rdoc_dir = "doc"
+  project.author = ["Kouhei Sutou"]
+  project.email = ['kou@cozmixng.org']
+  project.summary = 'Ruby bindings for cairo'
+  project.url = 'http://test-unit-ext.rubyforge.org/'
+
+  news_of_current_release = File.read("NEWS.en").split(/^==\s.*$/)[1]
+  project.changes = cleanup_white_space(news_of_current_release)
+
+  entries = File.read("README.en").split(/^==\s(.*)$/)
+  whats_this = cleanup_white_space(entries[entries.index("What\'s this?") + 1])
+  project.summary, project.description, = whats_this.split(/\n\n+/, 3)
+end
+
+spec = project.spec
+spec.rdoc_options = spec.rdoc_options.collect do |option|
+  option == "README.txt" ? "README.en" : option
+end
+spec.extra_rdoc_files += spec.files.grep(/(:?README|NEWS)\.(:?ja|en)\z/)
+spec.dependencies.delete_if {|dependency| dependency.name == "hoe"}
+
+rdoc_task = nil
+if ObjectSpace.each_object(Rake::RDocTask) {|rdoc_task|} != 1
+  puts "hoe may be changed"
+end
+rdoc_task.main = "README.en"
+rdoc_task.options.delete("-d")
+rdoc_task.options << "--charset=UTF-8"
+rdoc_task.template = "kilmer"
+rdoc_task.rdoc_files += ["README.en", "NEWS.en"]
+
+desc 'Tag the repository for release.'
+task :tag do
+  message = "Released TestUnitExt #{version}!"
+  base = "svn+ssh://#{ENV['USER']}@rubyforge.org/var/svn/test-unit-ext/"
+  sh 'svn', 'copy', '-m', message, "#{base}trunk", "#{base}tags/#{version}"
+end
+
+desc "Publish static HTML files"
+task :publish_html do
+  ruby "misc/rd2html.rb"
+  Dir.glob("html/*.html.en") do |html_en|
+    FileUtils.cp(html_en, html_en.sub(/\.en$/, ''))
+  end
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{project.rubyforge_name}"
+  local_dir = "html"
+  sh "rsync #{project.rsync_args} #{local_dir}/*.html* #{host}:#{remote_dir}"
+end
+task :publish_docs => :publish_html
+
+desc "Distribute new release."
+task :dist => [:publish_docs, :release, :tag, :announce]

data/test-unit-ext/lib/test-unit-ext/assertions.rb

@@ -0,0 +1,40 @@
+require "test/unit/testcase"
+
+module Test
+  module Unit
+    module AssertionsWithDiff
+      def assert_equal(expected, actual, message=nil)
+        super
+      rescue AssertionFailedError
+        expected = PP.pp(expected, "") unless expected.is_a?(String)
+        actual = PP.pp(actual, "") unless actual.is_a?(String)
+        diff = Diff.readable(expected, actual)
+        if /^[\?\-\+].{79}/ =~ diff
+          folded_diff = Diff.readable(fold(expected), fold(actual))
+          diff = "#{diff}\n\nfolded diff:\n#{folded_diff}"
+        end
+        raise $!, "#{$!.message}\n\ndiff:\n#{diff}", $@
+      end
+
+      def fold(string)
+        string.split(/\n/).collect do |line|
+          line.gsub(/(.{78})/, "\\1\n")
+        end.join("\n")
+      end
+    end
+
+    module AdditionalAssertions
+      def assert_boolean(expected)
+        assert([true, false].include?(expected),
+               build_message(nil,
+                             "<true or false> expected but was\n<?>",
+                             expected))
+      end
+    end
+
+    class TestCase
+      include AssertionsWithDiff
+      include AdditionalAssertions
+    end
+  end
+end