Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

EXODIST / Test2-Harness-1.000048 / lib / App / Yath / Options / Workspace.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
—
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

              
package App::Yath::Options::Workspace;
use strict;
use warnings;
our $VERSION = '1.000048';
use File::Spec();
use File::Path qw/remove_tree/;
use File::Temp qw/tempdir/;
use Test2::Harness::Util qw/clean_path chmod_tmp/;
use App::Yath::Options;
option_group {prefix => 'workspace', category => "Workspace Options"} => sub {
    option tmp_dir => (
        type        => 's',
        short       => 't',
        alt         => ['tmpdir'],
        description => 'Use a specific temp directory (Default: use system temp dir)',
        env_vars => [qw/T2_HARNESS_TEMP_DIR YATH_TEMP_DIR TMPDIR TEMPDIR TMP_DIR TEMP_DIR/],
        default     => sub { File::Spec->tmpdir },
    );
    option workdir => (
        type         => 's',
        short        => 'w',
        description  => 'Set the work directory (Default: new temp directory)',
        env_vars => [qw/T2_WORKDIR YATH_WORKDIR/],
        clear_env_vars => 1,
        normalize    => \&clean_path,
    );
    option clear => (
        short       => 'C',
        description => 'Clear the work directory if it is not already empty',
    );
    post sub {
        my %params   = @_;
        my $settings = $params{settings};
        if (my $workdir = $settings->workspace->workdir) {
            if (-d $workdir) {
                remove_tree($workdir, {safe => 1, keep_root => 1}) if $settings->workspace->clear;
            }
            else {
                mkdir($workdir) or die "Could not create workdir: $!";
                chmod_tmp($workdir);
            }
            return;
        }
        my $project = $settings->harness->project;
        my $template = join '-' => ( "yath", $$, "XXXXXX");
        my $tmpdir = tempdir(
            $template,
            DIR     => $settings->workspace->tmp_dir,
            CLEANUP => !($settings->debug->keep_dirs || $params{command}->always_keep_dir),
        );
        chmod_tmp($tmpdir);
        $settings->workspace->field(workdir => $tmpdir);
    };
};
1;
=pod
=encoding UTF-8
=head1 NAME
App::Yath::Options::Workspace - Options for specifying the yath work dir.
=head1 DESCRIPTION
Options regarding the yath working directory.
=head1 PROVIDED OPTIONS
=head2 COMMAND OPTIONS
=head3 Workspace Options
=over 4
=item --clear
=item -C
=item --no-clear
Clear the work directory if it is not already empty
=item --tmp-dir ARG
=item --tmp-dir=ARG
=item --tmpdir ARG
=item --tmpdir=ARG
=item -t ARG
=item -t=ARG
=item --no-tmp-dir
Use a specific temp directory (Default: use system temp dir)
Can also be set with the following environment variables: C<T2_HARNESS_TEMP_DIR>, C<YATH_TEMP_DIR>, C<TMPDIR>, C<TEMPDIR>, C<TMP_DIR>, C<TEMP_DIR>
=item --workdir ARG
=item --workdir=ARG
=item -w ARG
=item -w=ARG
=item --no-workdir
Set the work directory (Default: new temp directory)
Can also be set with the following environment variables: C<T2_WORKDIR>, C<YATH_WORKDIR>
=back
=head1 SOURCE
The source code repository for Test2-Harness can be found at
F<http://github.com/Test-More/Test2-Harness/>.
=head1 MAINTAINERS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 AUTHORS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 COPYRIGHT
Copyright 2020 Chad Granum E<lt>exodist7@gmail.comE<gt>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See F<http://dev.perl.org/licenses/>
=cut