Skip to content
Browse files

Initial commit.

  • Loading branch information...
0 parents commit 462a6e39ec93b05076e8056d8277e8635ddc60c4 @soh-cah-toa committed
Showing with 508 additions and 0 deletions.
  1. +5 −0 ChangeLog
  2. +201 −0 LICENSE
  3. +11 −0 META.info
  4. +72 −0 README
  5. +98 −0 lib/Test/Builder.pm
  6. +22 −0 lib/Test/Builder/Output.pm
  7. +21 −0 lib/Test/Builder/Plan.pm
  8. +78 −0 lib/Test/Builder/Test.pm
5 ChangeLog
@@ -0,0 +1,5 @@
+2011-09-30 Kevin Polulak <kpolulak@gmail.com>
+ * Release 0.0.1
+ - No tests yet
+ - No documentation
+ - README
201 LICENSE
@@ -0,0 +1,201 @@
+ The Artistic License 2.0
+
+ Copyright (c) 2000-2006, The Perl Foundation.
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+Preamble
+
+This license establishes the terms under which a given free software
+Package may be copied, modified, distributed, and/or redistributed.
+The intent is that the Copyright Holder maintains some artistic
+control over the development of that Package while still keeping the
+Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this
+license directly with the Copyright Holder of a given Package. If the
+terms of this license do not permit the full use that you propose to
+make of the Package, you should contact the Copyright Holder and seek
+a different licensing arrangement.
+
+Definitions
+
+ "Copyright Holder" means the individual(s) or organization(s)
+ named in the copyright notice for the entire Package.
+
+ "Contributor" means any party that has contributed code or other
+ material to the Package, in accordance with the Copyright Holder's
+ procedures.
+
+ "You" and "your" means any person who would like to copy,
+ distribute, or modify the Package.
+
+ "Package" means the collection of files distributed by the
+ Copyright Holder, and derivatives of that collection and/or of
+ those files. A given Package may consist of either the Standard
+ Version, or a Modified Version.
+
+ "Distribute" means providing a copy of the Package or making it
+ accessible to anyone else, or in the case of a company or
+ organization, to others outside of your company or organization.
+
+ "Distributor Fee" means any fee that you charge for Distributing
+ this Package or providing support for this Package to another
+ party. It does not mean licensing fees.
+
+ "Standard Version" refers to the Package if it has not been
+ modified, or has been modified only in ways explicitly requested
+ by the Copyright Holder.
+
+ "Modified Version" means the Package, if it has been changed, and
+ such changes were not explicitly requested by the Copyright
+ Holder.
+
+ "Original License" means this Artistic License as Distributed with
+ the Standard Version of the Package, in its current version or as
+ it may be modified by The Perl Foundation in the future.
+
+ "Source" form means the source code, documentation source, and
+ configuration files for the Package.
+
+ "Compiled" form means the compiled bytecode, object code, binary,
+ or any other form resulting from mechanical transformation or
+ translation of the Source form.
+
+
+Permission for Use and Modification Without Distribution
+
+(1) You are permitted to use the Standard Version and create and use
+Modified Versions for any purpose without restriction, provided that
+you do not Distribute the Modified Version.
+
+
+Permissions for Redistribution of the Standard Version
+
+(2) You may Distribute verbatim copies of the Source form of the
+Standard Version of this Package in any medium without restriction,
+either gratis or for a Distributor Fee, provided that you duplicate
+all of the original copyright notices and associated disclaimers. At
+your discretion, such verbatim copies may or may not include a
+Compiled form of the Package.
+
+(3) You may apply any bug fixes, portability changes, and other
+modifications made available from the Copyright Holder. The resulting
+Package will still be considered the Standard Version, and as such
+will be subject to the Original License.
+
+
+Distribution of Modified Versions of the Package as Source
+
+(4) You may Distribute your Modified Version as Source (either gratis
+or for a Distributor Fee, and with or without a Compiled form of the
+Modified Version) provided that you clearly document how it differs
+from the Standard Version, including, but not limited to, documenting
+any non-standard features, executables, or modules, and provided that
+you do at least ONE of the following:
+
+ (a) make the Modified Version available to the Copyright Holder
+ of the Standard Version, under the Original License, so that the
+ Copyright Holder may include your modifications in the Standard
+ Version.
+
+ (b) ensure that installation of your Modified Version does not
+ prevent the user installing or running the Standard Version. In
+ addition, the Modified Version must bear a name that is different
+ from the name of the Standard Version.
+
+ (c) allow anyone who receives a copy of the Modified Version to
+ make the Source form of the Modified Version available to others
+ under
+
+ (i) the Original License or
+
+ (ii) a license that permits the licensee to freely copy,
+ modify and redistribute the Modified Version using the same
+ licensing terms that apply to the copy that the licensee
+ received, and requires that the Source form of the Modified
+ Version, and of any works derived from it, be made freely
+ available in that license fees are prohibited but Distributor
+ Fees are allowed.
+
+
+Distribution of Compiled Forms of the Standard Version
+or Modified Versions without the Source
+
+(5) You may Distribute Compiled forms of the Standard Version without
+the Source, provided that you include complete instructions on how to
+get the Source of the Standard Version. Such instructions must be
+valid at the time of your distribution. If these instructions, at any
+time while you are carrying out such distribution, become invalid, you
+must provide new instructions on demand or cease further distribution.
+If you provide valid instructions or cease distribution within thirty
+days after you become aware that the instructions are invalid, then
+you do not forfeit any of your rights under this license.
+
+(6) You may Distribute a Modified Version in Compiled form without
+the Source, provided that you comply with Section 4 with respect to
+the Source of the Modified Version.
+
+
+Aggregating or Linking the Package
+
+(7) You may aggregate the Package (either the Standard Version or
+Modified Version) with other packages and Distribute the resulting
+aggregation provided that you do not charge a licensing fee for the
+Package. Distributor Fees are permitted, and licensing fees for other
+components in the aggregation are permitted. The terms of this license
+apply to the use and Distribution of the Standard or Modified Versions
+as included in the aggregation.
+
+(8) You are permitted to link Modified and Standard Versions with
+other works, to embed the Package in a larger work of your own, or to
+build stand-alone binary or bytecode versions of applications that
+include the Package, and Distribute the result without restriction,
+provided the result does not expose a direct interface to the Package.
+
+
+Items That are Not Considered Part of a Modified Version
+
+(9) Works (including, but not limited to, modules and scripts) that
+merely extend or make use of the Package, do not, by themselves, cause
+the Package to be a Modified Version. In addition, such works are not
+considered parts of the Package itself, and are not subject to the
+terms of this license.
+
+
+General Provisions
+
+(10) Any use, modification, and distribution of the Standard or
+Modified Versions is governed by this Artistic License. By using,
+modifying or distributing the Package, you accept this license. Do not
+use, modify, or distribute the Package, if you do not accept this
+license.
+
+(11) If your Modified Version has been derived from a Modified
+Version made by someone other than you, you are nevertheless required
+to ensure that your Modified Version complies with the requirements of
+this license.
+
+(12) This license does not grant you the right to use any trademark,
+service mark, tradename, or logo of the Copyright Holder.
+
+(13) This license includes the non-exclusive, worldwide,
+free-of-charge patent license to make, have made, use, offer to sell,
+sell, import and otherwise transfer the Package with respect to any
+patent claims licensable by the Copyright Holder that are necessarily
+infringed by the Package. If you institute patent litigation
+(including a cross-claim or counterclaim) against any party alleging
+that the Package constitutes direct or contributory patent
+infringement, then this Artistic License to you shall terminate on the
+date that such litigation is filed.
+
+(14) Disclaimer of Warranty:
+THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
+IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
+NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL
+LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
11 META.info
@@ -0,0 +1,11 @@
+{
+ "name" : "Test::Builder",
+ "version" : "0.0.1",
+ "description" : "Flexible framework for building TAP test libraries",
+ "author" : "Kevin Polulak",
+ "authority" : "soh-cah-toa",
+ "depends" : [],
+ "source-type" : "git",
+ "source-url" : "git://github.com/soh-cah-toa/p6-test-builder.git"
+}
+
72 README
@@ -0,0 +1,72 @@
+Test::Builder
+=============
+
+This is a flexible framework for building TAP test libraries.
+
+It provides the basic "building blocks" and generic functionality needed for building your own
+application-specific TAP test libraries.
+
+
+Source Code
+===========
+
+The source code for Test::Builder is available at <https://github.com/soh-cah-toa/p6-test-builder>.
+
+To obtain a local copy of the source code, run:
+
+ git clone git://github.com/soh-cah-toa/p6-test-builder.git p6-test-builder
+
+
+Installation
+============
+
+Once you've obtained a copy of the source code, run:
+
+ ufo # Creates Makefile
+ make # Builds module
+ make test # Runs test suite
+ make install # Installs to ~/.perl6/lib
+
+If you wish to remove the files generated during the build/install process, run:
+
+ make clean # Removes generated files
+ make distclean # 'make clean' and removes Makefile
+
+
+Feedback
+========
+
+If you experience a bug, error, or just want to make a suggestion, there a several ways to get in
+contact with me.
+
+ Email: You may send an email to <kpolulak@gmail.org>. If it's about a bug, please give a
+ detailed description of what caused it, preferably with the exact output.
+
+ IRC: I can be found regularly lurking around #parrot on irc.perl.org and #perl6 on
+ irc.freenode.net where I go under the nickname "soh_cah_toa".
+
+ GitHub: You may send a private message to soh-cah-toa (note the hyphens) if you have a GitHub
+ account.
+
+If you know how to fix the problem you encountered, consider sending a patch (via 'git diff') or
+forking a clone on GitHub and submitting a Pull Request.
+
+
+Author
+======
+
+Kevin Polulak
+ Email: kpolulak@gmail.com
+ IRC: soh_cah_toa
+
+
+Copyright and License
+=====================
+
+Copyright (C) 2011, Kevin Polulak <kpolulak@gmail.com>.
+
+This program is distributed under the terms of the Artistic License 2.0.
+
+For further information, please see LICENSE or visit
+<http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt>.
+
98 lib/Test/Builder.pm
@@ -0,0 +1,98 @@
+# Copyright (C) 2011, Kevin Polulak <kpolulak@gmail.com>.
+
+# TODO Make Test::Builder a singleton object
+# TODO Replace die() with fail()
+
+=begin pod
+
+=head1 NAME
+
+Test::Builder - flexible framework for building TAP test libraries
+
+=head1 SYNOPSIS
+
+=begin code
+
+ my $tb = Test::Builder.new;
+
+ $tb.plan(2);
+
+ $tb.ok(1, 'This is a test');
+ $tb.ok(1, 'This is another test');
+
+ $tb.done;
+
+=end code
+
+=head1 DESCRIPTION
+
+=head1 METHODS
+
+=head1 ACKNOWLEDGEMENTS
+
+C<Test::Builder> was largely inspired by chromatic's work on the old
+C<Test::Builder> module for Pugs.
+
+Additionally, C<Test::Builder> is based on the Perl 5 module of the same name
+also written by chromatic <chromatic@wgz.org> and Michael G. Schwern
+<schwern@pobox.com>.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011, Kevin Polulak <kpolulak@gmail.com>.
+
+This program is distributed under the terms of the Artistic License 2.0.
+
+For further information, please see LICENSE or visit
+<http://www.perlfoundation.org/attachment/legal/artistic-2_0.txt>.
+
+=end pod
+
+class Test::Builder:<soh_cah_toa 0.0.1>;
+ has Test::Builder::Test @!results;
+
+ has Test::Builder::Plan $!plan;
+ has Test::Builder::Output $!output;
+
+ submethod BUILD(Test::Builder::Plan $!plan?,
+ Test::Builder::Output $!output = Test::Builder::Output.new) { }
+
+ # TODO Refactor done() into an END block
+ method done() {
+ my $footer = $!plan.footer(+@!results);
+ $!output.write($footer) if $footer;
+ }
+
+ multi method plan(Int $tests) {
+ die 'Plan already set!' if $!plan;
+
+ $!plan = Test::Builder::Plan.new(:expected($tests));
+ }
+
+ # TODO Implement skip_all and no_plan
+ multi method plan(Str $explanation) { ... }
+
+ multi method plan(Any $any) {
+ die 'Unknown plan!';
+ }
+
+ method ok(Mu $passed, Str $description= '') {
+ self!report_test(Test::Builder::Test.new(:number(self!get_test_number),
+ :passed($passed),
+ :description($description)));
+ }
+
+ method !report_test(Test::Builder::Test::Base $test) {
+ die 'No plan set!' unless $!plan;
+
+ @!results.push($test);
+
+ $!output.write($test.report);
+ }
+
+ method !get_test_number() {
+ return +@!results + 1;
+ }
+
+# vim: ft=perl6
+
22 lib/Test/Builder/Output.pm
@@ -0,0 +1,22 @@
+# Copyright (C) 2011, Kevin Polulak <kpolulak@gmail.com>.
+
+class Test::Builder::Output {
+ has $!stdout;
+ has $!stderr;
+
+ submethod BUILD($!stdout = $*OUT, $!stderr = $*ERR) { ... }
+
+ method write(Str $msg is copy) {
+ $msg ~~ s:g/\n <!before \#>/\n \# <space>/;
+ $!stdout.say($msg);
+ }
+
+ method diag(Str $msg is copy) {
+ $msg ~~ s/^ <!before \#>/\# <space>/;
+ $msg ~~ s:g/\n <!before \#>/\n \# <space>/;
+ $!stderr.say($msg);
+ }
+}
+
+# vim: ft=perl6
+
21 lib/Test/Builder/Plan.pm
@@ -0,0 +1,21 @@
+# Copyright (C) 2011, Kevin Polulak <kpolulak@gmail.com>.
+
+class Test::Builder::Plan {
+ has Int $!expected;
+
+ submethod BUILD($!expected = 0) {
+ die 'Invalid or missing plan!' unless $!expected.defined;
+ }
+
+ method header() returns Str {
+ return "1..$!expected";
+ }
+
+ method footer(Int $ran) returns Str {
+ return '' if $ran == $!expected;
+ return "Expected $!expected but ran $ran";
+ }
+}
+
+# vim: ft=perl6
+
78 lib/Test/Builder/Test.pm
@@ -0,0 +1,78 @@
+# Copyright (C) 2011, Kevin Polulak <kpolulak@gmail.com>.
+
+# TODO Rename Test::Builder::Base to something else
+# FIXME This should probably be a class, not a role
+# FIXME Refactor Test::Builder::Base inheritance tree
+
+class Test::Builder::Test::Pass does Test::Builder::Test::Base { }
+class Test::Builder::Test::Fail does Test::Builder::Test::Base { }
+
+role Test::Builder::Test::Base {
+ has Bool $.passed;
+ has Int $.number = 0;
+ has Str $.diagnostic = '???';
+ has Str $.description;
+
+ method status() returns Hash {
+ return {
+ passed => $!passed,
+ description => $!description
+ };
+ }
+
+ method report() returns Str {
+ my $result = $!passed ?? 'ok ' !! 'not ok ';
+
+ $result ~= $!number;
+ $result ~= " - $!description" if $!description;
+
+ return $result;
+ }
+}
+
+class Test::Builder::Test {
+ has $!passed;
+ has $!number;
+ has $!diag;
+ has $!description;
+
+ # XXX Should $passed be of type Bool instead?
+
+ method new(Int :$number,
+ Int :$passed = 1,
+ Int :$skip = 0,
+ Int :$todo = 0,
+ Str :$reason = '',
+ Str :$description = '') {
+
+ #return Todo.new(:description($description),
+ #:passed($passed),
+ #:reason($reason),
+ #:number($number)) if $todo;
+
+ #return Skip.new(:description($description),
+ #:passed(1),
+ #:reason($reason),
+ #:number($number)) if $skip;
+
+ return Test::Builder::Test::Pass.new(:description($description),
+ :passed(1),
+ :number($number)) if $passed;
+
+ return Test::Builder::Test::Fail.new(:description($description),
+ :passed(0),
+ :number($number));
+ }
+
+ method report() returns Str {
+ my $result = $!passed ?? 'ok ' !! 'not ok ';
+
+ $result ~= $!number;
+ $result ~= " - $!description" if $!description;
+
+ return $result;
+ }
+}
+
+# vim: ft=perl6
+

0 comments on commit 462a6e3

Please sign in to comment.
Something went wrong with that request. Please try again.