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
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::System::Console::Command::Dev::Code::Generate::UnitTest::Backend;
## nofilter(TidyAll::Plugin::OTRS::Perl::LayoutObject)
use strict;
use warnings;
use File::Path ();
use File::Basename ();
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::Config',
'Kernel::System::Main',
'Kernel::Output::HTML::Layout',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Generate a test skeleton.');
$Self->AddOption(
Name => 'module-directory',
Description =>
"Specify the directory containing the module where the new test should be created (otherwise the OTRS home directory will be used).",
Required => 0,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
$Self->AddArgument(
Name => 'target-path',
Description => "Specify the path to the new test (e.g. MyModule/SubTest).",
Required => 1,
ValueRegex => qr/.*/smx,
);
return;
}
sub PreRun {
my ( $Self, %Param ) = @_;
my $ModuleDirectory = $Self->GetOption('module-directory');
if ( $ModuleDirectory && !-d $ModuleDirectory ) {
die "Directory $ModuleDirectory does not exist.\n";
}
return;
}
sub Run {
my ( $Self, %Param ) = @_;
my $Home = $Kernel::OM->Get('Kernel::Config')->Get('Home');
my $TargetHome = $Home;
my $ModuleDirectory = $Self->GetOption('module-directory');
if ($ModuleDirectory) {
$TargetHome = $ModuleDirectory;
}
# Keep comment lines in files also in the generated output.
local $ENV{TEMPLATE_KEEP_COMMENTS} = 1;
my $TargetPath = $Self->GetArgument('target-path');
# create Test module file
my $SkeletonFile = __FILE__;
$SkeletonFile =~ s{Backend\.pm$}{Backend/Backend.t.skel}xms;
my $SkeletonTemplate = $Kernel::OM->Get('Kernel::System::Main')->FileRead(
Location => $SkeletonFile,
);
if ( !$SkeletonTemplate || !${$SkeletonTemplate} ) {
$Self->PrintError("Could not read $SkeletonFile.");
return $Self->ExitCodeError();
}
my $Skeleton = $Kernel::OM->Get('Kernel::Output::HTML::Layout')->Output(
Template => ${$SkeletonTemplate},
);
my $TargetLocation = "$TargetHome/scripts/test/$TargetPath.t";
my $TargetDirectory = File::Basename::dirname($TargetLocation);
if ( !-d $TargetDirectory ) {
File::Path::make_path($TargetDirectory);
}
if ( -f $TargetLocation ) {
$Self->PrintError("$TargetLocation already exists.");
return $Self->ExitCodeError();
}
my $Success = $Kernel::OM->Get('Kernel::System::Main')->FileWrite(
Location => $TargetLocation,
Content => \$Skeleton,
);
if ( !$Success ) {
$Self->PrintError("Could not generate $TargetLocation.\n");
return $Self->ExitCodeError();
}
$Self->Print("<green>Generated:</green> <yellow>$TargetLocation</yellow>\n");
return $Self->ExitCodeOk();
}
1;
|
