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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
#############################################################################
##
## Copyright (C) 2015 The Qt Company Ltd.
## Contact: http://www.qt.io/licensing/
##
## This file is part of the Quality Assurance module of the Qt Toolkit.
##
## $QT_BEGIN_LICENSE:LGPL21$
## Commercial License Usage
## Licensees holding valid commercial Qt licenses may use this file in
## accordance with the commercial license agreement provided with the
## Software or, alternatively, in accordance with the terms contained in
## a written agreement between you and The Qt Company. For licensing terms
## and conditions see http://www.qt.io/terms-conditions. For further
## information use the contact form at http://www.qt.io/contact-us.
##
## GNU Lesser General Public License Usage
## Alternatively, this file may be used under the terms of the GNU Lesser
## General Public License version 2.1 or version 3 as published by the Free
## Software Foundation and appearing in the file LICENSE.LGPLv21 and
## LICENSE.LGPLv3 included in the packaging of this file. Please review the
## following information to ensure the GNU Lesser General Public License
## requirements will be met: https://www.gnu.org/licenses/lgpl.html and
## http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
##
## As a special exception, The Qt Company gives you certain additional
## rights. These rights are described in The Qt Company LGPL Exception
## version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
##
## $QT_END_LICENSE$
##
#############################################################################
package QtQA::App::TestRunner::Plugin::testcocoon;
use strict;
use warnings;
use Carp;
use Cwd;
use English qw( -no_match_vars );
use File::Basename;
use File::Copy;
use File::Find::Rule;
use File::Path qw( mkpath );
use File::Spec::Functions;
use Getopt::Long qw(GetOptionsFromArray);
use Readonly;
sub new
{
my ($class, %args) = @_;
my $testcocoon_tests_output;
my $qt_gitmodule_dir;
my $qt_gitmodule;
GetOptionsFromArray( $args{ argv },
'testcocoon-tests-output=s' => \$testcocoon_tests_output,
'testcocoon-qt-gitmodule-dir=s' => \$qt_gitmodule_dir,
'testcocoon-qt-gitmodule=s' => \$qt_gitmodule,
) || pod2usage(1);
if (!$testcocoon_tests_output) {
confess "Missing required '--testcocoon-tests-output' option";
} else {
my $output_dir = dirname( $testcocoon_tests_output );
if (! -d $output_dir && ! mkpath( $output_dir )) {
confess "mkpath $output_dir: $!";
}
$args{ testcocoon_tests_output } = $testcocoon_tests_output;
}
if ((!$qt_gitmodule_dir) or (! -d $qt_gitmodule_dir)) {
confess "Invalid or missing required '--testcocoon-qt-gitmodule-dir' option";
} else {
$args{ testcocoon_qt_gitmodule_dir } = $qt_gitmodule_dir;
}
if (!$qt_gitmodule) {
confess "Missing required '--testcocoon-qt-gitmodule' option";
} else {
$args{ testcocoon_qt_gitmodule } = $qt_gitmodule;
}
return bless \%args, $class;
}
sub run_completed
{
my ($self) = @_;
my $tests_target = $self->{ testcocoon_tests_output };
my $testrunner = $self->{ testrunner };
my $qt_gitmodule_dir = $self->{ testcocoon_qt_gitmodule_dir };
my $qt_gitmodule = $self->{ testcocoon_qt_gitmodule };
my $test_basename = basename(($testrunner->command( ))[0]);
my $test_dir = getcwd;
# Get all csmes found under test folder
my @all_test_csmes = File::Find::Rule->file()->name( '*.csmes' )->in($test_dir);
@all_test_csmes = map { canonpath($_) } sort(@all_test_csmes);
# merge all csmes found under the test folder and merge them in a global csmes
my $test_global_csmes = catfile($test_dir, "${test_basename}_global.csmes");
foreach my $sub_csmes (@all_test_csmes) {
if (-e $test_global_csmes) {
$self->system_call('cmmerge', '--append', "--output=$test_global_csmes", $sub_csmes);
} else {
copy($sub_csmes, $test_global_csmes) or confess "copy $sub_csmes: $!";
}
}
my $qt_git_qtbase_dir =
($qt_gitmodule eq 'qtbase') ? $qt_gitmodule_dir
: ($qt_gitmodule eq 'qt5') ? catfile($qt_gitmodule_dir, 'qtbase')
: catfile($qt_gitmodule_dir, '..', 'qtbase');
# Get plugins and imports dir
my $qt_git_qtbase_pluginsdir = catfile($qt_git_qtbase_dir, 'plugins');
my $qt_git_qtbase_importsdir = catfile($qt_git_qtbase_dir, 'imports');
if (-e $test_global_csmes) {
# Merge each plugins and import code database (csmes) in one global database with all plugins/imports
my @all_pluginsandimport_csmes = File::Find::Rule->file()->name( '*.csmes' )->in($qt_git_qtbase_pluginsdir);
push @all_pluginsandimport_csmes, File::Find::Rule->file()->name( '*.csmes' )->in($qt_git_qtbase_importsdir);
@all_pluginsandimport_csmes = map { canonpath($_) } sort(@all_pluginsandimport_csmes);
foreach my $csmes (@all_pluginsandimport_csmes) {
$self->system_call('cmmerge', '--append', "--output=$test_global_csmes", $csmes);
}
# Get all csexe files found under the test folder (except tools csexe: moc, uic and rcc) and import them
# FIXME Getting code coverage data for/from the tools. We don't export the tools csexe because tools are using a
# separately compiled version of some QtBase sources. This means they are incompatible with the tests csmes used here.
my @all_test_csexe = File::Find::Rule->file()->name( '*.csexe' )->in($test_dir);
@all_test_csexe = map { canonpath($_) } sort(@all_test_csexe);
foreach my $sub_csexe (@all_test_csexe) {
my $csexe_basename;
$csexe_basename = basename($sub_csexe);
if (!($csexe_basename =~ m/^(moc|uic|rcc)\.csexe$/)) {
$self->system_call('cmcsexeimport', "--csmes=$test_global_csmes", "--csexe=$sub_csexe", "--title=tc_$test_basename", '--policy=merge');
# Delete the csexe to save space.
unlink($sub_csexe) or confess "unlink $sub_csexe: $!";
}
}
if (-e $tests_target) {
$self->system_call('cmmerge', '--append', "--output=$tests_target", $test_global_csmes);
} else {
copy($test_global_csmes, $tests_target) or confess "copy $test_global_csmes: $!";
}
# Delete the global csmes to save space
unlink($test_global_csmes) or confess "unlink $test_global_csmes: $!";
} else {
$testrunner->print_info( "warning: $test_basename csmes file is missing\n" );
}
return;
}
sub system_call
{
my ($self, @command) = @_;
print "+ @command\n";
(!system(@command)) or (confess "@command exited with error $?");
return;
}
=head1 NAME
QtQA::App::TestRunner::Plugin::testcocoon - gather code coverage information of all tests in a single database.
=head1 SYNOPSIS
# With this plugin
# $ ./testrunner --plugin testcocoon --testcocoon-tests-output "$HOME/all_tests.cmses" --testcocoon-qt-gitmodule-dir "$HOME/git/qt5/qtbase" --testcocoon-qt-gitmodule qtbase -- ./tst_mytest
# $HOME/all-tests.csmes will be created and will gather all code coverage information collected from
# the tests after they have been executed. All the plugins csmes are merge with each test csmes.
=head1 DESCRIPTION
This plugin provides a simple mechanism to import each test execution report (csexe) into
its source database (csmes). This plugin purpose is to create a global database (csmes)
gathering all those tests source databases.
=head1 OPTIONS
=over
=item B<--testcocoon-tests-output> <fullpath>
Required. Full path to the global tests database to create. Must contain a full path to a csmes file.
(First time, the file should not exist to avoid data corruption)
=item B<--testcocoon-qt-gitmodule-dir> <directory>
Required. the git dir is used to retrieve the plugins csmes and then collect the plugin execution data.
=item B<--testcocoon-qt-gitmodule> <directory>
Required. Name of the git module (e.g. 'qtbase')
=back
=head1 CAVEATS
Requires tests and tested code to be built with testcocoon configure option enabled.
=cut
1;
|
