blackstart 0.2.0 → 0.8.0

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1,191 @@
+Blackstart
+
+Blackstart is a small, subdued library for automated testing in Ruby. It
+doesn't depend on anything beyond the Ruby platform and doesn't modify the
+environment beyond its conventional namespace. The program that tests it is
+written in primitive Ruby, with no other testing library, so it can be verified
+straightforwardly.
+
+The blackstart is a small, subdued bird that eats bugs. A black start is when
+an inactive power plant restarts by means of an independent power source rather
+than the electrical grid.
+
+Here's an example of a test program that uses Blackstart:
+
+  require "blackstart"
+
+  exit Blackstart.run [
+    lambda {
+      unless "Hello, World!" == ["He", "", "o, Wor", "d!"].join("l")
+        raise "join did not work as expected"
+      end
+    },
+
+    lambda {
+      unless "sample" == "simple".gsub(/i/, "a")
+        raise "gsub did not work as expected"
+      end
+    }
+  ]
+
+Blackstart.run runs a sequence of tests and reports information about any that
+fail. It returns false if there were failures, true otherwise.
+
+An array of procs is an easy way to represent a sequence of tests. In general,
+the sequence can be any object that responds to an each message in the
+conventional way and each test object in the sequence can be any object that
+(1) is a proc or converts to one via to_proc and (2) converts to a string via
+to_s.
+
+Each test is run by converting the test object to a proc if necessary and then
+calling it in the context of a new instance of Blackstart::Scratchpad; if and
+only if this raises an error (any exception that's a kind of StandardError),
+Blackstart.run interprets it as a failed test.
+
+After each test failure, Blackstart.run sends a puts message with failure
+information to its second parameter, which is $stdout by default. The failure
+information includes a description of the test (the test object converted to a
+string) and a description of the error raised (its class, string
+representation, and backtrace).
+
+If a test raises a non-StandardError exception, Blackstart.run interprets it as
+a system-level event or fundamental problem: it immediately raises the
+exception and doesn't run any more tests.
+
+The library provides little beyond this, but it supports more sophisticated
+uses. Some examples follow.
+
+
+- Exiting with the appropriate status
+
+You may want your test program to exit with a successful status only if there
+were no failures, perhaps so it can work as part of a testing script. You can
+do this by using the object returned by Blackstart.run as the argument to
+Kernel#exit. Blackstart.run returns false if there were failures, true
+otherwise.
+
+
+- Defining helpers
+
+You may want to enable all your tests to assert something, generate test data,
+or perform some other task by sending a message. You could implement this
+statelessly in a singleton object or all instances of Object, for example, but
+there's another option that may be more convenient. When Blackstart.run calls a
+test proc, it sets the self object to a new instance of Blackstart::Scratchpad.
+You can define instance methods in that class. For example:
+
+  class Blackstart::Scratchpad
+    def assert boolean
+      raise "assertion failed" unless boolean
+    end
+
+    def make_products
+      @cabbage = { :description => "head of cabbage", :price => 125 }
+      @orange = { :description => "Cara Cara navel orange", :price => 100 }
+      nil
+    end
+  end
+
+All your test procs can use them by sending messages to self. These methods,
+like the test proc itself, can see and modify instance variables and other
+elements of the scratchpad's state. The scratchpad is disposable:
+Blackstart.run discards it after the test is complete.
+
+
+- Running code before and after each test
+
+You may want to run code before and after each test -- for example, to create
+objects needed in tests or clean up resources without requiring every test to
+do these explicitly. You can do this by defining a custom
+Blackstart::Scratchpad#instance_exec. For example:
+
+  class Blackstart::Scratchpad
+    def instance_exec(*)
+      puts "before test"
+      @variable = "example"
+      super
+    ensure
+      puts "after test"
+    end
+  end
+
+Use this technique with care because the test proc could send instance_exec
+messages to self.
+
+
+- Building a test collection in stages
+
+You may want to build a test collection in stages rather than all at once. This
+can be done straightforwardly:
+
+  require "blackstart"
+
+  TESTS = []
+
+  TESTS.concat [
+    lambda {
+      unless "Hello, World!" == ["He", "", "o, Wor", "d!"].join("l")
+        raise "join did not work as expected"
+      end
+    }
+  ]
+
+  TESTS.concat [
+    lambda {
+      unless "sample" == "simple".gsub(/i/, "a")
+        raise "gsub did not work as expected"
+      end
+    }
+  ]
+
+  exit Blackstart.run TESTS
+
+This pattern is useful if you want to define your tests in multiple files: you
+create a collection with an agreed-upon name, load multiple files, each of
+which adds test objects to that collection, and then run all the tests.
+
+
+- Running tests in random order
+
+To check if you have any tests that depend on other tests having run, or not
+having run, earlier, you may want to run your tests in random order.
+Blackstart.run runs a sequence of tests in order, but you can pass it a
+randomly-ordered sequence. Array#shuffle may be helpful for this. If you use
+Array#shuffle or something similar, you may also want to print the random seed
+just before the tests are shuffled so you can rerun your tests in the same
+order by setting the random seed.
+
+
+- Reporting detailed test descriptions
+
+After a test fails, Blackstart.run writes a string describing the test to the
+output stream. It gets this string by sending a to_s message to the test
+object. When the test object is an instance of Proc, the returned string
+typically includes the file path and line number where it was defined: helpful,
+but it won't be immediately clear what was being tested.
+
+You can improve this by designing your own test objects. Blackstart.run does
+not strictly need a sequence of procs; it also works with a sequence of objects
+that convert to procs in response to to_proc messages. Your custom test objects
+can respond to to_s with detailed descriptions instead of mere file paths and
+line numbers.
+
+
+- Handling failures differently
+
+Blackstart.run handles each failure by sending a puts message to the output
+stream, one of its parameters, with failure information. By default, the output
+stream is $stdout, so the default behavior is to print unadorned failure
+information to standard output. But you can specify any object as the output
+stream -- even if it's not really a stream -- allowing you to handle failure
+information however you want.
+
+
+- Running multiple tests at the same time
+
+Although Blackstart.run is written in a sequential style, it can run multiple
+tests at the same time. Blackstart.run sends an each message with a block to
+your test collection, expecting the block to be executed once for each test;
+your test collection can execute the block in multiple threads concurrently.
+For your program to work well in this mode, your tests and the output stream
+must work correctly when used from multiple threads.

data/lib/blackstart.rb

@@ -1,92 +1,76 @@
 ##
-# This module provides facilities for defining and running automated tests.
+# This module provides facilities for running automated tests.
 
 module Blackstart
 
   ##
-  # Calls the block and returns a string describing the error raised, if any.
+  # Yields to the block and returns a string describing the error raised, if
+  # any.
   #
-  # In detail: This method sends call with no arguments to the object
-  # representing the block. If that raises an error -- that is, an exception
-  # whose class is StandardError or a descendent of StandardError -- this
-  # method creates a string describing that error and returns it; the
-  # description includes the error's class, message, and backtrace (if any). If
-  # sending the message raises any other exception, this method raises that
-  # exception. If sending the message does not raise an exception, this method
-  # returns nil.
+  # In detail: This method yields to the block with no arguments. If that
+  # raises an error -- meaning an exception whose class is StandardError or a
+  # descendant of StandardError -- this method attempts to make and return a
+  # string describing that error; the description consists of the error's
+  # class, string representation, and backtrace (if any). If an exception is
+  # raised while making an error description, this method raises that
+  # exception. If yielding to the block raises a non-error exception, this
+  # method raises that exception. If yielding to the block does not raise an
+  # exception, this method returns nil.
 
-  def self.vet &prc
-    prc.call
+  def self.vet
+    yield
     nil
-  rescue ::StandardError
+  rescue ::StandardError => e
     # Like IO#puts, separate lines with a line feed character rather than $\.
-    ["#{$!.class}: #{$!.message}"].concat($!.backtrace || []).join "\n"
+    ["#{e.class}: #{e}"].concat(e.backtrace || []).join "\n"
   end
 
   ##
-  # Allows the block to add procs to a collection, which it returns.
-  #
-  # In detail: This method sends call with one positional argument, an adder
-  # object, to the object representing the block, director. This block can send
-  # call messages to the adder to add objects representing the respective
-  # blocks to the collection, sink. With each sending of call, the object to be
-  # added will be either a proc (if call is sent with a block) or nil (if call
-  # is sent without a block). If any non-block arguments are sent with the call
-  # message, an exception is raised. To add the object, the adder sends a <<
-  # message to sink with the object as the positional argument and no other
-  # arguments. The adder returns nil in response to a call message if it
-  # returns at all. This method returns sink.
-  #
-  # By default, sink is a new empty array.
-
-  def self.add sink = [], &director
-    director.call ::Kernel.lambda { |&prc|
-      sink << prc
-      nil
-    }
-    sink
-  end
-
-  ##
-  # A class for the contexts (the self objects) of tests.
+  # A class for tests' disposable helper objects.
 
-  class Context
+  class Scratchpad
   end
 
   ##
-  # Runs the tests, writes any failure information to the output stream, and
+  # Runs tests, writes any failure information to the output stream, and
   # returns a boolean indicating whether there were no failures.
   #
-  # In detail: This method expects the sequence of test objects, source, to
-  # respond to an each message by yielding successive test objects to its
-  # block. Each test is run by converting the test object to a proc and calling
-  # it in the context of a new instance of Blackstart::Context. A failure is
-  # when the test raises an error (that is, an exception whose class is
-  # StandardError or a descendent of StandardError). After a failure, this
-  # method sends a puts message to the output stream, ostream, with these
-  # arguments (positional, in order): a string "FAILED TEST:", the test object
-  # converted to a string via to_s, a string "...ERROR:", a string describing
-  # the error, and an empty string. If a test raises any other exception, this
-  # method immediately raises that exception. After it has run all the tests
-  # and handled any failures, this method returns false if there were failures
-  # or true otherwise.
+  # In detail: This method sends an each message with a block to the sequence
+  # of test objects, source, expecting it to yield to the block once for each
+  # test object in the sequence with that test object as the first argument.
+  # Each test involves creating a new scratchpad -- an instance of
+  # Blackstart::Scratchpad -- and sending an instance_exec message to it with
+  # the test object as the block, which converts the test object to a proc via
+  # to_proc if it's not already a proc. The resulting proc is called with no
+  # arguments and no block; the self object is set to the scratchpad. A failure
+  # is when the test (which includes any initial conversion to a proc) raises
+  # an error: an exception whose class is StandardError or a descendant of
+  # StandardError. After a failure, this method sends a puts message to the
+  # output stream, ostream, with no block and these arguments (positional, in
+  # order): a string "FAILED TEST:"; the test object converted to a string via
+  # to_s; a string "...ERROR:"; a string combining the class, string
+  # representation, and backtrace of the error; and an empty string. If a test
+  # raises a non-error exception, this method immediately raises that
+  # exception. After it has run all the tests and handled any failures, this
+  # method returns false if there were failures, true otherwise. This method
+  # immediately raises any exception raised outside of a test.
   #
   # By default, ostream is $stdout.
 
   def self.run source, ostream = $stdout
-    success = true
-    for tst in source
-      # Convert to a proc and create a context outside the vet block so that
-      # this method will raise any exception that results instead of
-      # potentially treating it as a test failure.
-      prc = ::Proc.new(&tst)
-      context = Context.new
-      if err_desc = vet { context.instance_exec(&prc) }
-        success = false
-        ostream.puts "FAILED TEST:", tst.to_s, "...ERROR:", err_desc.to_s, ""
+    no_failures = true
+    source.each do |tst|
+      # Create the scratchpad outside the vet block so that this method will
+      # raise any exception that results instead of potentially treating it as
+      # a test failure.
+      scratchpad = ::Blackstart::Scratchpad.new
+      if err_desc = vet { scratchpad.instance_exec(&tst) }
+        no_failures = false
+        ostream.puts "FAILED TEST:", tst.to_s, "...ERROR:", err_desc, ""
       end
+      nil
     end
-    success
+    no_failures
   end
 
 end

data/sig/blackstart.rbs

@@ -0,0 +1,18 @@
+module Blackstart
+  def self.vet: () ?{ () -> void } -> ::String?
+
+  class Scratchpad
+  end
+
+  type test_proc = ^() [self: Scratchpad] -> void
+  interface _ConvertsToTestProc
+    def to_proc: () -> test_proc
+  end
+  type test = (test_proc | _ConvertsToTestProc) & ::_ToS
+
+  interface _OutputStream
+    def puts: (::String, ::String, ::String, ::String, ::String) -> void
+  end
+
+  def self.run: (::_Each[test], ?_OutputStream) -> bool
+end