| 1 | package Test::FitNesse::Slim; | ||
| 2 | |||
| 3 | 4 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 4 | ▶ | use warnings; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 5 | |||
| 6 | 4 | our $VERSION = '1.00'; | |
| 7 | |||
| 8 | 4 | 1; | |
| 9 | |||
| 10 | =head1 NAME | ||
| 11 | |||
| 12 | Test::FitNesse::Slim - Perl implementation of the FitNesse SLiM protocol | ||
| 13 | |||
| 14 | =head1 VERSION | ||
| 15 | |||
| 16 | Version 1.00 | ||
| 17 | |||
| 18 | =head1 DESCRIPTION | ||
| 19 | |||
| 20 | C<Test::FitNesse::Slim> implements the server side of FitNesse's Simple List | ||
| 21 | Invocation Method (SLiM) protocol. This package provides the distribution | ||
| 22 | version and documentation; it does not expose a constructor or exported | ||
| 23 | function API. | ||
| 24 | |||
| 25 | L<Test::FitNesse::Slim::Server> processes framed requests, executes fixture | ||
| 26 | instructions, and writes responses. The C<perl-slim> executable is the | ||
| 27 | normal way to start the server. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | Start the v0.5 stdin/stdout transport as a FitNesse-managed child process: | ||
| 32 | |||
| 33 | perl-slim 1 | ||
| 34 | |||
| 35 | Start a TCP listener on port 8099: | ||
| 36 | |||
| 37 | perl-slim 8099 | ||
| 38 | |||
| 39 | For pipe transport, configure FitNesse with C<COMMAND_PATTERN=%m>, | ||
| 40 | C<TEST_RUNNER> set to the installed executable, and C<SLIM_PORT=1>. For TCP, | ||
| 41 | configure the FitNesse SLiM service to connect to the listener's host and | ||
| 42 | port. See C<docs/slim-pipe-transport.md> and | ||
| 43 | C<docs/fitnesse-cli-runner-configuration.md> for complete examples. | ||
| 44 | |||
| 45 | Fixture authors declare conversion metadata with C<slim_method_signature> | ||
| 46 | and C<slim_constructor_signature>. See C<docs/fixture-conversion.md> for | ||
| 47 | supported types and a runnable fixture example. | ||
| 48 | |||
| 49 | =head1 SUPPORT | ||
| 50 | |||
| 51 | The project repository is at L<https://github.com/gbacon/test-slim>. Report | ||
| 52 | bugs and compatibility findings through the project's issue tracker. | ||
| 53 | |||
| 54 | =head1 AUTHOR | ||
| 55 | |||
| 56 | Greg Bacon, C<< <gbacon@gbacon.com> >> | ||
| 57 | |||
| 58 | =head1 COPYRIGHT AND LICENSE | ||
| 59 | |||
| 60 | Copyright 2010-2026 Greg Bacon. | ||
| 61 | |||
| 62 | This program is free software; you can redistribute it and/or modify it | ||
| 63 | under the terms of either the GNU General Public License, version 1 or any | ||
| 64 | later version, or the Artistic License 1.0. The test-only FitNesse fixture | ||
| 65 | adaptations listed in C<THIRD-PARTY-NOTICES.md> are separately licensed under | ||
| 66 | the Common Public License 1.0. See the included license files for details. | ||
| 67 | |||
| 68 | =cut | ||