pytest is not correctly auto-installed
[WebKit-https.git] / Tools / Scripts / build-webkit
1 #!/usr/bin/env perl
2
3 # Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Apple Inc. All rights reserved.
4 # Copyright (C) 2009 Google Inc. All rights reserved.
5 # Copyright (C) 2010 moiji-mobile.com All rights reserved.
6 # Copyright (C) 2011 Research In Motion Limited. All rights reserved.
7 # Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
8 #
9 # Redistribution and use in source and binary forms, with or without
10 # modification, are permitted provided that the following conditions
11 # are met:
12 #
13 # 1.  Redistributions of source code must retain the above copyright
14 #     notice, this list of conditions and the following disclaimer. 
15 # 2.  Redistributions in binary form must reproduce the above copyright
16 #     notice, this list of conditions and the following disclaimer in the
17 #     documentation and/or other materials provided with the distribution. 
18 # 3.  Neither the name of Apple Inc. ("Apple") nor the names of
19 #     its contributors may be used to endorse or promote products derived
20 #     from this software without specific prior written permission. 
21 #
22 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
23 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
26 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 # Build script wrapper for the WebKit Open Source Project.
34
35 use strict;
36 use warnings;
37 use File::Basename;
38 use File::Find;
39 use File::Spec;
40 use FindBin;
41 use Getopt::Long qw(:config pass_through no_auto_abbrev);
42 use lib $FindBin::Bin;
43 use webkitdirs;
44 use List::Util qw(first);
45 use webkitperl::FeatureList qw(getFeatureOptionList);
46 use POSIX;
47
48 sub writeCongrats();
49
50 checkRequiredSystemConfig();
51 setConfiguration();
52
53 if (shouldUseFlatpak()) {
54     print "Building flatpak based environment\n";
55
56     runInFlatpak("/app/webkit/Tools/Scripts/build-webkit");
57 }
58
59 my $originalWorkingDirectory = getcwd();
60 chdirWebKit();
61
62 my $showHelp = 0;
63 my $verbose = 0;
64 my $clean = 0;
65 my $minimal = 0;
66 my $installHeaders;
67 my $installLibs;
68 my $prefixPath;
69 my $makeArgs = "";
70 my @cmakeArgs;
71 my $onlyWebKitProject = 0;
72 my $coverageSupport = 0;
73 my $shouldRunStaticAnalyzer = 0;
74 my $noExperimentalFeatures = 0;
75 my $ltoMode = "default";
76 my $startTime = time();
77 my $archs32bit = 0;
78 my $skipLibraryUpdate = 0;
79 my $useCCache = -1;
80
81 my @features = getFeatureOptionList();
82
83 # Additional environment parameters
84 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'}) if ($ENV{'BUILD_WEBKIT_ARGS'});
85
86 # Initialize values from defaults
87 foreach (@ARGV) {
88     if ($_ eq '--minimal') {
89         $minimal = 1;
90     } elsif ($_ eq 'ARCHS=i386' or $_ eq 'ARCHS=armv7' or $_ eq 'ARCHS=armv7s') {
91         $archs32bit = 1;
92     }
93 }
94
95 # Feature flags default to undefined, where they will inherit the default value
96 # specified by the build system, or to 'off' if --minimal is specified.
97 foreach (@features) {
98     ${$_->{value}} = ($minimal ? 0 : undef);
99 }
100
101 my $programName = basename($0);
102 my $usage = <<EOF;
103 Usage: $programName [options] [options to pass to build system]
104   --help                            Show this help message
105   --verbose                         Show verbose build output
106   --clean                           Cleanup the build directory
107   --generate-project-only           Only generate project files
108   --debug                           Compile with Debug configuration
109   --release                         Compile with Release configuration
110   --sdk=<sdk>                       Use a specific Xcode SDK (iOS and Mac only)
111   --ios-device                      Use "iphoneos.internal" SDK if installed, else "iphoneos" SDK (iOS only)
112   --device                          DEPRECATED alias of --ios-device
113   --ios-simulator                   Use "iphonesimulator.internal" SDK if installed, else "iphonesimulator" SDK (iOS only)
114   --simulator                       DEPRECATED alias of --ios-simulator
115   --coverage                        Enable code coverage support (Mac only)
116   --analyze                         Enable static anaylsis (iOS and Mac only)
117   --lto-mode=<mode>                 Set Link Time Optimization mode (full, thin, or none) (Xcode only)
118
119   --gtk                             Build the GTK+ port
120   --wpe                             Build the WPE port
121   --wincairo                        Build using Cairo (rather than CoreGraphics) on Windows
122   --playstation                     Build the PlayStation port
123
124   --inspector-frontend              Copy Web Inspector user interface resources to the build directory
125
126   --prefix=<path>                   Set installation prefix to the given path (CMake only, except Windows)
127   --makeargs=<arguments>            Optional Makefile flags
128   --cmakeargs=<arguments>           One or more optional CMake flags (e.g. --cmakeargs="-DFOO=bar -DCMAKE_PREFIX_PATH=/usr/local")
129
130   --minimal                         No optional features, unless explicitly enabled
131   --no-experimental-features        No experimental features, unless explicitly enabled (CMake only)
132
133   --only-webkit                     Build only the WebKit project
134
135   --skip-library-update             Skip the check to see if windows libraries are up to date
136
137   --[no-]use-ccache                 Enable (or disable) CCache, if available
138
139 EOF
140
141 my %options = (
142     'help' => \$showHelp,
143     'v|verbose' => \$verbose,
144     'clean' => \$clean,
145     'install-headers=s' => \$installHeaders,
146     'install-libs=s' => \$installLibs,
147     'prefix=s' => \$prefixPath,
148     'makeargs=s' => \$makeArgs,
149     'cmakeargs=s' => \@cmakeArgs,
150     'minimal' => \$minimal,
151     'only-webkit' => \$onlyWebKitProject,
152     'coverage' => \$coverageSupport,
153     'analyze' => \$shouldRunStaticAnalyzer,
154     'no-experimental-features' => \$noExperimentalFeatures,
155     'lto-mode=s' => \$ltoMode,
156     'skip-library-update' => \$skipLibraryUpdate,
157     'use-ccache!' => \$useCCache,
158 );
159
160 # Build usage text and options list from features
161 foreach (@features) {
162     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
163     $usage .= "$opt $_->{desc}\n";
164     $options{"$_->{option}!"} = $_->{value};
165 }
166
167 GetOptions(%options);
168
169 if ($showHelp) {
170    print STDERR $usage;
171    exit 1;
172 }
173
174 $ENV{'VERBOSE'} = 1 if $verbose;
175
176 if ($useCCache == 1) {
177     $ENV{'WK_USE_CCACHE'} = "YES";
178 } elsif ($useCCache == 0) {
179     $ENV{'WK_USE_CCACHE'} = "NO";
180 }
181
182
183 my $productDir = productDir();
184
185 # Check that all the project directories are there.
186 my @projects = ("Source/JavaScriptCore", "Source/WebCore", "Source/WebKitLegacy");
187
188 # Build WTF as a separate static library on ports which support it.
189 splice @projects, 0, 0, "Source/WTF" if isAppleWebKit() or isWinCairo();
190
191 splice @projects, 0, 0, "Source/bmalloc" if isAppleCocoaWebKit();
192
193 # Ports using CMake will check if directories exist in the CMake configuration.
194 if (!isCMakeBuild()) {
195     for my $dir (@projects) {
196         if (! -d $dir) {
197             die "Error: No $dir directory found. Please do a fresh checkout.\n";
198         }
199     }
200 }
201
202 if ((isAppleWebKit() || isWinCairo() || isPlayStation()) && !-d "WebKitLibraries") {
203     die "Error: No WebKitLibraries directory found. Please do a fresh checkout.\n";
204 }
205
206 my @options = ();
207
208 if (isAppleCocoaWebKit()) {
209     push @options, XcodeOptions();
210     sub option($$)
211     {
212         my ($feature, $isEnabled) = @_;
213         return "" if not defined $isEnabled;
214         return $feature . "=" . ($isEnabled ? $feature : "");
215     }
216
217     foreach (@features) {
218         my $option = option($_->{define}, ${$_->{value}});
219         push @options, $option unless $option eq "";
220     }
221
222     # ANGLE and libwebrtc must come before WebCore
223     splice @projects, 0, 0, ("Source/ThirdParty/ANGLE");
224     if (not $archs32bit and ((portName() eq Mac and not architecture() eq "i386") or 
225         (portName() eq iOS and (architecture() eq "arm64" or architecture() eq "x86_64")))) {
226         splice @projects, 0, 0, ("Source/ThirdParty/libwebrtc");
227     }
228
229     push @projects, ("Source/WebKit");
230
231     if (!isIOSWebKit()) {
232         push @projects, ("Tools/MiniBrowser");
233
234         # WebInspectorUI must come after JavaScriptCore and WebCore but before WebKit and WebKit2
235         my $webKitIndex = first { $projects[$_] eq "Source/WebKitLegacy" } 0..$#projects;
236         splice(@projects, $webKitIndex, 0, "Source/WebInspectorUI");
237
238         # Copy library and header from WebKitLibraries to a findable place in the product directory.
239         my @copyLibrariesArgs = ("perl", "Tools/Scripts/copy-webkitlibraries-to-product-directory", "--wksi",  productDir());
240         print(join(" ", @copyLibrariesArgs) . "\n");
241         (system(@copyLibrariesArgs) == 0) or die;
242     } else {
243         my @copyLibrariesArgs = ("perl", "Tools/Scripts/copy-webkitlibraries-to-product-directory", "--sdk", xcodeSDK(), "--wksi");
244         push @copyLibrariesArgs, productDir();
245         print(join(" ", @copyLibrariesArgs) . "\n");
246         (system(@copyLibrariesArgs) == 0) or die;
247     }
248
249     # Build Tools needed for Apple ports
250     push @projects, ("Tools/DumpRenderTree", "Tools/WebKitTestRunner", "Source/ThirdParty/gtest", "Tools/TestWebKitAPI");
251
252 } elsif (isWinCairo() && !$skipLibraryUpdate) {
253     (system("python Tools/Scripts/update-webkit-wincairo-libs.py") == 0) or die;
254 } elsif (isAppleWinWebKit() && !$skipLibraryUpdate) {
255     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
256     # Will fail if WebKitSupportLibrary.zip is not in source root.
257     (system("perl Tools/Scripts/update-webkit-support-libs") == 0) or die;
258     (system("perl Tools/Scripts/update-webkit-auxiliary-libs") == 0) or die;
259     setupAppleWinEnv()
260 }
261
262 if (isAnyWindows()) {
263     system("python Tools/Scripts/update-vswhere.py");
264 }
265
266 # If asked to build just the WebKit project, overwrite the projects
267 # list after all of the port specific tweaks have been made to
268 # build options, etc.
269 @projects = ("Source/WebKitLegacy") if $onlyWebKitProject;
270
271 my $result = 0;
272
273 if (isInspectorFrontend()) {
274     die "The --inspector-frontend option is not supported for CMake-based builds." if isCMakeBuild();
275     @projects = ("Source/WebInspectorUI");
276 }
277
278 if (isCMakeBuild() && !isAnyWindows()) {
279     if (!canUseNinja() || defined($ENV{NUMBER_OF_PROCESSORS})) {
280         # If the user environment is not setting a specific number of process,
281         # then don't pass the number of jobs to Ninja. Because Ninja will
282         # automatically determine the number of jobs to run in parallel.
283         $makeArgs .= ($makeArgs ? " " : "") . "-j" . numberOfCPUs() if $makeArgs !~ /-j\s*\d+/;
284     }
285
286     my $maxCPULoad = maxCPULoad() if $makeArgs !~ /-l\s*\d+\.?\d*/;
287     $makeArgs .= " -l" . maxCPULoad() if defined $maxCPULoad;
288
289     # We remove CMakeCache to avoid the bots reusing cached flags when
290     # we enable new features. This forces a reconfiguration.
291     my @featureArgs = cmakeArgsFromFeatures(@features, !$noExperimentalFeatures);
292     removeCMakeCache(@featureArgs);
293
294     buildCMakeProjectOrExit($clean, $prefixPath, $makeArgs, @featureArgs, @cmakeArgs);
295 }
296
297 my $baseProductDir = baseProductDir();
298 if (isAppleWinWebKit() || isWinCairo() || isPlayStation()) {
299     my @featureArgs = cmakeArgsFromFeatures(@features, !$noExperimentalFeatures);
300     removeCMakeCache(@featureArgs);
301
302     chdirWebKit();
303     if (exitStatus(generateBuildSystemFromCMakeProject($prefixPath, @featureArgs, @cmakeArgs))) {
304         die "Run Visual Studio 2017 installation vcvars.bat before build-webkit when using ninja";
305     }
306
307     exit 0 if isGenerateProjectOnly();
308
309     chdirWebKit();
310     if (canUseNinja()) {
311         chdir File::Spec->catdir($baseProductDir, configuration());
312         $result = system("ninja");
313     } else {
314         $result = buildVisualStudioProject(File::Spec->catfile($baseProductDir, configuration(), "WebKit.sln"), $clean);
315     }
316     if (exitStatus($result)) {
317         my $scriptDir = relativeScriptsDir();
318         if (isAppleWinWebKit() || isWinCairo()) {
319             print "\n\n===== BUILD FAILED ======\n\n";
320             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
321             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
322         }
323         exit exitStatus($result);
324     }
325 } elsif (isAppleCocoaWebKit() && !isCMakeBuild()) {
326     exit 0 if isGenerateProjectOnly();
327
328     # Build, and abort if the build fails.
329     for my $dir (@projects) {
330         chdir $dir or die;
331         $result = 0;
332
333         my $project = basename($dir);
334         
335         my @local_options = @options;
336         push @local_options, XcodeCoverageSupportOptions() if $coverageSupport;
337         push @local_options, XcodeStaticAnalyzerOption() if $shouldRunStaticAnalyzer;
338         push @local_options, "WK_LTO_MODE=$ltoMode" if ($ltoMode ne "default");
339         my $projectPath = $project =~ /gtest/ ? "xcode/gtest" : $project;
340         $result = buildXCodeProject($projectPath, $clean, @local_options, @ARGV);
341
342         # Various build* calls above may change the CWD.
343         chdirWebKit();
344
345         if (exitStatus($result)) {
346             exit exitStatus($result);
347         }
348     }
349
350     # Build ImageDiff for host
351     my @command = File::Spec->catfile(getcwd(), "/Tools/Scripts/build-imagediff");
352     chdirWebKit();
353     if (!-e $command[0]) {
354         die "build-imagediff script not found";
355     }
356
357     if ($clean) {
358         push @command, " --clean";
359     }
360     push @command, argumentsForConfiguration();
361     push @command, @ARGV;
362     @command = extractNonMacOSHostConfiguration(\@command);
363     $result = system(@command);
364     if (exitStatus($result)) {
365         exit exitStatus($result);
366     }
367 }
368
369 # Don't report the "WebKit is now built" message after a clean operation.
370 exit if $clean;
371
372 # Don't report congrats message if build was interrupted by the user.
373 exit if ($result & 127) == SIGINT;
374
375 # Explicitly chdir back to where exit will take us anyway, since the following "launcher"
376 # message is relative to that directory.
377 chdir $originalWorkingDirectory;
378
379 # Write out congratulations message.
380 writeCongrats();
381
382 exit 0;
383
384 sub writeCongrats()
385 {
386     my $launcherPath = launcherPath();
387     my $launcherName = launcherName();
388     my $endTime = time();
389     my $buildTime = formatBuildTime($endTime - $startTime);
390
391     print "\n";
392     print "====================================================================\n";
393     print " WebKit is now built ($buildTime). \n";
394     if ($launcherPath && $launcherName) {
395         print " To run $launcherName with this newly-built code, use the\n";
396         print " \"$launcherPath\" script.\n";
397     }
398     print "====================================================================\n";
399 }