NAME

Alien::Build::Plugin::Test::Mock - Mock plugin for testing

VERSION

version 2.81_01

SYNOPSIS

use alienfile;
plugin 'Test::Mock' => (
  probe    => 'share',
  download => 1,
  extract  => 1,
  build    => 1,
  gather   => 1,
);

DESCRIPTION

This plugin is used for testing Alien::Build plugins. Usually you only want to test one or two phases in an alienfile for your plugin, but you still have to have a fully formed alienfile that contains all required phases. This plugin lets you fill in the other phases with the appropriate hooks. This is usually better than using real plugins which may pull in additional dynamic requirements that you do not want to rely on at test time.

PROPERTIES

probe

plugin 'Test::Mock' => (
  probe => $probe,
);

Override the probe behavior by one of the following:

share

For a share build.

system

For a system build.

die

To throw an exception in the probe hook. This will usually cause Alien::Build to try the next probe hook, if available, or to assume a share install.

download

plugin 'Test::Mock' => (
  download => \%fs_spec,
);

plugin 'Test::Mock' => (
  download => 1,
);

Mock out a download. The %fs_spec is a hash where the hash values are directories and the string values are files. This a spec like this:

plugin 'Test::Mock' => (
  download => {
    'foo-1.00' => {
      'README.txt' => "something to read",
      'foo.c' => "#include <stdio.h>\n",
                 "int main() {\n",
                 "  printf(\"hello world\\n\");\n",
                 "}\n",
    }
  },
);

Would generate two files in the directory 'foo-1.00', a README.txt and a C file named foo.c. The default, if you provide a true non-hash value is to generate a single tarball with the name foo-1.00.tar.gz.

extract

plugin 'Test::Mock' => (
  extract => \%fs_spec,
);

plugin 'Test::Mock' => (
  extract => 1,
);

Similar to download above, but for the extract phase.

build

plugin 'Test::Mock' => (
  build => [ \%fs_spec_build, \%fs_spec_install ],
);

plugin 'Test::Mock' => (
  build => 1,
);

gather

plugin 'Test::Mock' => (
  gather => \%runtime_prop,
);

plugin 'Test::Mock' => (
  gather => 1,
);

This adds a gather hook (for both share and system) that adds the given runtime properties, or if a true non-hash value is provided, some reasonable runtime properties for testing.

check_digest

plugin 'Test::Mock' => (
  check_digest => 1,  # the default
);

This adds a check_digest hook that uses fake algorithm FAKE that hashes everything to deadbeaf. The mock download above will set the digest for download_details so that this will pass the signature check.

plugin 'Test::Mock' => (
  check_digest => sub {
    my($build, $file, $algo, $digest) = @_;
    ...
  },
);

If you give it a code reference then you can write your own faux digest. See the check_digest hook in Alien::Build::Manual::PluginAuthor for details.

AUTHOR

Author: Graham Ollis <plicease@cpan.org>

Contributors:

Diab Jerius (DJERIUS)

Roy Storey (KIWIROY)

Ilya Pavlov

David Mertens (run4flat)

Mark Nunberg (mordy, mnunberg)

Christian Walde (Mithaldu)

Brian Wightman (MidLifeXis)

Zaki Mughal (zmughal)

mohawk (mohawk2, ETJ)

Vikas N Kumar (vikasnkumar)

Flavio Poletti (polettix)

Salvador Fandiño (salva)

Gianni Ceccarelli (dakkar)

Pavel Shaydo (zwon, trinitum)

Kang-min Liu (劉康民, gugod)

Nicholas Shipp (nshp)

Juan Julián Merelo Guervós (JJ)

Joel Berger (JBERGER)

Petr Písař (ppisar)

Lance Wicks (LANCEW)

Ahmad Fatoum (a3f, ATHREEF)

José Joaquín Atria (JJATRIA)

Duke Leto (LETO)

Shoichi Kaji (SKAJI)

Shawn Laffan (SLAFFAN)

Paul Evans (leonerd, PEVANS)

Håkon Hægland (hakonhagland, HAKONH)

nick nauwelaerts (INPHOBIA)

Florian Weimer

COPYRIGHT AND LICENSE

This software is copyright (c) 2011-2022 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Alien::Build

perl -MCPAN -e shell
install Alien::Build