inconsistencies with handling of inherit_version, inherit_missing options

[karenetheridge]

The build.log at https://rt.cpan.org/Ticket/Display.html?id=107362 is quite troubling. The test is failing due to an unexpected result for module versions in the provides hash -- my test was assuming that the distribution version would be used, rather than the module versions.

However, on closer inspection it would appear that the test is actually wrong (given the configs inherit_version => 0, inherit_missing => 0 (https://metacpan.org/source/ETHER/Dist-Zilla-PluginBundle-Author-ETHER-0.105/lib/Dist/Zilla/PluginBundle/Author/ETHER.pm#L261) -- so, why do the tests pass on my machine and apparently on all cpantesters systems, but not for ribasushi?

[karenetheridge]

There's definitely something wrong with the implementation of the inherit_* options here. Since it's not possible to tell the installed version of the roles you pull in, I would suggest including those in dump_config.

[kentfredric]

re: dump_config , I'm confused what you're asking:

https://metacpan.org/source/ETHER/Dist-Zilla-PluginBundle-Author-ETHER-0.105/META.json#L951-954

Wouldn't traversing the stack of roles applied to plugins and extracting their versions be a job for https://metacpan.org/source/RJBS/Dist-Zilla-5.039/lib/Dist/Zilla/Plugin/MetaConfig.pm#L42-50

There's been no functional changes as far as I can recall / can see in the changelogs in inherit_version handling since long before the first version that had configuration dumping support.

But seeing the configuration dumping is working fine in the failing case, I'm not sure what's going on here yet.

[kentfredric]

I can however confirm that I can't reproduce the fail.

[karenetheridge]

The fail that ribasushi had, you mean? That was actually the correct code behaviour.

Consider the test at this commit: karenetheridge/Dist-Zilla-PluginBundle-Author-ETHER@9713ff7

This test is now supposed to pass, but as you can see it fails.

There is verbose log output at the end of the test, which may help. It would appear the inherit_* options are totally ignored and the defaults used instead.

[kentfredric]

I really need a smaller test case, I'm just getting nausea trying to read the tests which are deeply entwined with your bundle.

[ribasushi]

I can run any sort of code snippet and respond with what it outputs. If that helps.

[karenetheridge]

I'll create a self-contained test.

[karenetheridge]

I found (most of) the problem. tldr: pebkac. There might be something else still lurking however (e.g. I haven't yet explained how ribasushi experienced different behaviour than I did).

[kentfredric]

Yeah. I'm still interested in working out why riba's machine barfs, and not yours or mine. There's still a real bug lurking there, just where is not sure.

[karenetheridge]

This is a boiled down version of the test that failed for ribasushi, but ought to pass. If it reliably fails for him, it should be possible to figure out how this is happening.

use strict;
use warnings;

use Test::More;
use Test::Deep;
use Test::DZil;
use Test::Fatal;
use Path::Tiny;

my $tzil = Builder->from_config(
    { dist_root => 'does-not-exist' },
    {
        add_files => {
            path(qw(source dist.ini)) => simple_ini(
                {   # merge into root section
                    version => '0.005',
                },
                'GatherDir',
                [ 'RewriteVersion::Transitional' => {
                        ':version' => '0.004',
                        skip_version_provider => 1,
                        global => 1,
                        add_tarball_name => 0,
                        fallback_version_provider => 'Git::NextVersion',
                        version_regexp => '^v([\d._]+)(-TRIAL)?$',
                    } ],
                [ 'MetaNoIndex'         => { directory => [ qw(t xt), grep { -d } qw(inc local perl5 fatlib examples share corpus demo) ] } ],
                [ 'MetaProvides::Package' => { ':version' => '1.15000002', finder => ':InstallModules', meta_noindex => 1, inherit_version => 0, inherit_missing => 0 } ],
            ),
            path(qw(source lib DZT Sample.pm)) => "package DZT::Sample;\nour \$VERSION = '0.002';\n1",
            path(qw(source lib DZT Sample2.pm)) => "package DZT::Sample2;\n1",
        },
    },
);

$tzil->chrome->logger->set_debug(1);
is(
    exception { $tzil->build },
    undef,
    'build proceeds normally',
);

cmp_deeply(
    $tzil->distmeta,
    superhashof({
        provides => {
            # version edited, added (respectively) by [RewriteVersion::Transitional]
            'DZT::Sample'   => { file => 'lib/DZT/Sample.pm', version => '0.005' },
            'DZT::Sample2'  => { file => 'lib/DZT/Sample2.pm', version => '0.005' },
        },
    }),
    'config is properly included in metadata',
);

diag explain $tzil->distmeta;
diag 'got log messages: ', explain $tzil->log_messages;

done_testing;

[kentfredric]

@ribasushi ^ are you able to repeat the failure with the example code?

[ribasushi]

rabbit@Ahasver:~$ cpanm --look Dist::Zilla::PluginBundle::Author::ETHER
--> Working on Dist::Zilla::PluginBundle::Author::ETHER
Fetching http://www.cpan.org/authors/id/E/ET/ETHER/Dist-Zilla-PluginBundle-Author-ETHER-0.105.tar.gz ... OK
Entering /home/rabbit/.cpanm/work/1444387245.4938/Dist-Zilla-PluginBundle-Author-ETHER-0.105 with /bin/bash
rabbit@Ahasver:~/.cpanm/work/1444387245.4938/Dist-Zilla-PluginBundle-Author-ETHER-0.105$ prove -lv t/01-pluginbundle-basic.t t/04-pluginbundle-installer.t

[edit] Full log of ether bundle tests(fails): https://gist.github.com/kentfredric/871152df9dfc3720f090

rabbit@Ahasver:~/.cpanm/work/1444387245.4938/Dist-Zilla-PluginBundle-Author-ETHER-0.105$ prove -vl /dev/shm/example_from_Dist-Zilla-Plugin-MetaProvides-Package_issues_6 
/dev/shm/example_from_Dist-Zilla-Plugin-MetaProvides-Package_issues_6

[edit] Full log of ethers test(passes): https://gist.github.com/kentfredric/5d515d13134eea975916

[kentfredric]

The good news is, I think that riba gets these lines:

# [@Author::ETHER/MetaProvides::Package]   collect_pod => 0,
# [@Author::ETHER/MetaProvides::Package]   filename    => "/home/rabbit/.cpanm/work/1444387245.4938/Dist-Zilla-PluginBundle-Author-ETHER-0.105/tmp/bJ9i4F1CYi/source/lib/DZT/Sample2.pm",
# [@Author::ETHER/MetaProvides::Package]   inc         => undef,
# [@Author::ETHER/MetaProvides::Package]   module      => "DZT::Sample2",
# [@Author::ETHER/MetaProvides::Package]   packages    => ["DZT::Sample2"],
# [@Author::ETHER/MetaProvides::Package]   pod         => {},
# [@Author::ETHER/MetaProvides::Package]   version     => 0.001,
# [@Author::ETHER/MetaProvides::Package]   versions    => { "DZT::Sample2" => 0.001 },
# [@Author::ETHER/MetaProvides::Package] }, "Module::Metadata")',
#   '[@Author::ETHER/MetaProvides::Package] Version metadata for namespace DZT::Sample2 in lib/DZT/Sample2.pm : {
# [@Author::ETHER/MetaProvides::Package]   file    => "lib/DZT/Sample2.pm",
# [@Author::ETHER/MetaProvides::Package]   module  => "DZT::Sample2",
# [@Author::ETHER/MetaProvides::Package]   version => 0.001,
# [@Author::ETHER/MetaProvides::Package] }',
#   '[@Author::ETHER/MetaProvides::Package] Version metadata from lib/DZT/Sample.pm : bless({
# [@Author::ETHER/MetaProvides::Package]   collect_pod => 0,
# [@Author::ETHER/MetaProvides::Package]   filename    => "/home/rabbit/.cpanm/work/1444387245.4938/Dist-Zilla-PluginBundle-Author-ETHER-0.105/tmp/bJ9i4F1CYi/source/lib/DZT/Sample.pm",
# [@Author::ETHER/MetaProvides::Package]   inc         => undef,
# [@Author::ETHER/MetaProvides::Package]   module      => "DZT::Sample",
# [@Author::ETHER/MetaProvides::Package]   packages    => ["DZT::Sample"],
# [@Author::ETHER/MetaProvides::Package]   pod         => {},
# [@Author::ETHER/MetaProvides::Package]   version     => 0.001,
# [@Author::ETHER/MetaProvides::Package]   versions    => { "DZT::Sample" => 0.001 },
# [@Author::ETHER/MetaProvides::Package] }, "Module::Metadata")',

While I get these lines:

# [@Author::ETHER/MetaProvides::Package]   collect_pod => 0,
# [@Author::ETHER/MetaProvides::Package]   filename    => "/home/kent/.cpanm/work/1444389788.589150/Dist-Zilla-PluginBundle-Author-ETHER-0.105/tmp/pDKteIgtFw/source/lib/DZT/Sample2.pm",
# [@Author::ETHER/MetaProvides::Package]   inc         => undef,
# [@Author::ETHER/MetaProvides::Package]   module      => "DZT::Sample2",
# [@Author::ETHER/MetaProvides::Package]   packages    => ["DZT::Sample2"],
# [@Author::ETHER/MetaProvides::Package]   pod         => {},
# [@Author::ETHER/MetaProvides::Package]   version     => 0.005,
# [@Author::ETHER/MetaProvides::Package]   versions    => { "DZT::Sample2" => 0.005 },
# [@Author::ETHER/MetaProvides::Package] }, "Module::Metadata")',
#   '[@Author::ETHER/MetaProvides::Package] Version metadata for namespace DZT::Sample2 in lib/DZT/Sample2.pm : {
# [@Author::ETHER/MetaProvides::Package]   file    => "lib/DZT/Sample2.pm",
# [@Author::ETHER/MetaProvides::Package]   module  => "DZT::Sample2",
# [@Author::ETHER/MetaProvides::Package]   version => 0.005,
# [@Author::ETHER/MetaProvides::Package] }',
#   '[@Author::ETHER/MetaProvides::Package] Version metadata from lib/DZT/Sample.pm : bless({
# [@Author::ETHER/MetaProvides::Package]   collect_pod => 0,
# [@Author::ETHER/MetaProvides::Package]   filename    => "/home/kent/.cpanm/work/1444389788.589150/Dist-Zilla-PluginBundle-Author-ETHER-0.105/tmp/pDKteIgtFw/source/lib/DZT/Sample.pm",
# [@Author::ETHER/MetaProvides::Package]   inc         => undef,
# [@Author::ETHER/MetaProvides::Package]   module      => "DZT::Sample",
# [@Author::ETHER/MetaProvides::Package]   packages    => ["DZT::Sample"],
# [@Author::ETHER/MetaProvides::Package]   pod         => {},
# [@Author::ETHER/MetaProvides::Package]   version     => 0.005,
# [@Author::ETHER/MetaProvides::Package]   versions    => { "DZT::Sample" => 0.005 },
# [@Author::ETHER/MetaProvides::Package] }, "Module::Metadata")',

Which hopefully narrows the search scope.

The bad news is, ... that data is of course coming straight from Module::Metadata.

So that means the content is somehow different in the files themselves that is being parsed.