jib-profiles.js revision 1973:00ff6af007c0
1/* 2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26/* 27 * This file defines build profiles for the JIB tool and others. 28 * 29 * A build profile defines a set of configuration options and external 30 * dependencies that we for some reason or other care about specifically. 31 * Typically, build profiles are defined for the build configurations we 32 * build regularly. 33 * 34 * Contract against this file from the tools that use it, is to provide 35 * a function on the form: 36 * 37 * getJibProfiles(input) 38 * 39 * which returns an object graph describing the profiles and their 40 * dependencies. The name of the function is based on the name of this 41 * file, minus the extension and the '-', camel cased and prefixed with 42 * 'get'. 43 * 44 * 45 * The parameter 'input' is an object that optionally contains some data. 46 * Optionally because a tool may read the configuration for different purposes. 47 * To initially get a list of available profiles, the active profile may not 48 * yet be known for instance. 49 * 50 * Data that may be set on the input object: 51 * 52 * input.profile = <name of active profile> 53 * 54 * If the active profile is set, the following data from it must also 55 * be provided: 56 * 57 * input.profile 58 * input.target_os 59 * input.target_cpu 60 * input.build_os 61 * input.build_cpu 62 * input.target_platform 63 * input.build_platform 64 * // The build_osenv_* variables describe the unix layer on Windows systems, 65 * // i.e. Cygwin, which may also be 32 or 64 bit. 66 * input.build_osenv 67 * input.build_osenv_cpu 68 * input.build_osenv_platform 69 * 70 * For more complex nested attributes, there is a method "get": 71 * 72 * input.get("<dependency>", "<attribute>") 73 * 74 * Valid attributes are: 75 * install_path 76 * download_path 77 * download_dir 78 * 79 * 80 * The output data generated by this configuration file has the following 81 * format: 82 * 83 * data: { 84 * // Identifies the version of this format to the tool reading it 85 * format_version: "1.0", 86 * 87 * // Name of base outputdir. JIB assumes the actual output dir is formed 88 * // by adding the configuration name: <output_basedir>/<config-name> 89 * output_basedir: "build", 90 * // Configure argument to use to specify configuration name 91 * configuration_configure_arg: 92 * // Make argument to use to specify configuration name 93 * configuration_make_arg: 94 * 95 * profiles: { 96 * <profile-name>: { 97 * // Name of os the profile is built to run on 98 * target_os; <string> 99 * // Name of cpu the profile is built to run on 100 * target_cpu; <string> 101 * // Combination of target_os and target_cpu for convenience 102 * target_platform; <string> 103 * // Name of os the profile is built on 104 * build_os; <string> 105 * // Name of cpu the profile is built on 106 * build_cpu; <string> 107 * // Combination of build_os and build_cpu for convenience 108 * build_platform; <string> 109 * 110 * // List of dependencies needed to build this profile 111 * dependencies: <Array of strings> 112 * 113 * // List of configure args to use for this profile 114 * configure_args: <Array of strings> 115 * 116 * // List of free form labels describing aspects of this profile 117 * labels: <Array of strings> 118 * } 119 * } 120 * 121 * // Dependencies use a Maven like deployment structure 122 * dependencies: { 123 * <dependency-name>: { 124 * // Organization part of path defining this dependency 125 * organization: <string> 126 * // File extension for this dependency 127 * ext: <string> 128 * // Module part of path for defining this dependency, 129 * // defaults to <dependency-name> 130 * module: <string> 131 * // Revision part of path for defining this dependency 132 * revision: <string> 133 * 134 * // List of configure args to add when using this dependency, 135 * // defaults to 136 * // "--with-<dependency-name>=input.get("<dependency-name", "install_path")" 137 * configure_args: <array of strings> 138 * 139 * // Name of environment variable to set when using this dependency 140 * // when running make 141 * environment_name: <string> 142 * // Value of environment variable to set when using this dependency 143 * // when running make 144 * environment_value: <string> 145 * 146 * // Value to add to the PATH variable when using this dependency, 147 * // applies to both make and configure 148 * environment_path: <string> 149 * } 150 * 151 * <dependency-name>: { 152 * // For certain dependencies where a legacy distribution mechanism is 153 * // already in place, the "javare" server layout is also supported 154 * // Indicate that an alternate server source and layout should be used 155 * server: "javare" 156 * 157 * // For "javare", a combination of module, revision, 158 * // build number (optional), files and checksum file is possible for 159 * // artifacts following the standard layout. 160 * module: <string> 161 * revision: <string> 162 * build_number: <string> 163 * checksum_file: <string> 164 * file: <string> 165 * 166 * // For other files, use checksum path and path instead 167 * checksum_path: <string> 168 * path: <string> 169 * } 170 * } 171 * } 172 */ 173 174/** 175 * Main entry to generate the profile configuration 176 * 177 * @param input External data to use for generating the configuration 178 * @returns {{}} Profile configuration 179 */ 180var getJibProfiles = function (input) { 181 182 var data = {}; 183 184 // Identifies the version of this format to the tool reading it 185 data.format_version = "1.0"; 186 187 // Organization is used when uploading/publishing build results 188 data.organization = "com.oracle.jpg.jdk"; 189 190 // The base directory for the build output. JIB will assume that the 191 // actual build directory will be <output_basedir>/<configuration> 192 data.output_basedir = "build"; 193 // The configure argument to use to specify the name of the configuration 194 data.configuration_configure_arg = "--with-conf-name="; 195 // The make argument to use to specify the name of the configuration 196 data.configuration_make_arg = "CONF_NAME="; 197 198 // Define some common values 199 var common = getJibProfilesCommon(input); 200 // Generate the profiles part of the configuration 201 data.profiles = getJibProfilesProfiles(input, common); 202 // Generate the dependencies part of the configuration 203 data.dependencies = getJibProfilesDependencies(input, common); 204 205 return data; 206}; 207 208/** 209 * Generates some common values 210 * 211 * @param input External data to use for generating the configuration 212 * @returns Common values 213 */ 214var getJibProfilesCommon = function (input) { 215 var common = { 216 dependencies: ["boot_jdk", "gnumake", "jtreg"], 217 configure_args: ["--with-default-make-target=all"], 218 configure_args_32bit: ["--with-target-bits=32", "--with-jvm-variants=client,server"], 219 configure_args_debug: ["--enable-debug"], 220 configure_args_slowdebug: ["--with-debug-level=slowdebug"], 221 organization: "jpg.infra.builddeps" 222 }; 223 224 return common; 225}; 226 227/** 228 * Generates the profiles part of the configuration. 229 * 230 * @param input External data to use for generating the configuration 231 * @param common The common values 232 * @returns {{}} Profiles part of the configuration 233 */ 234var getJibProfilesProfiles = function (input, common) { 235 var profiles = {}; 236 237 // Main SE profiles 238 var mainProfiles = { 239 240 "linux-x64": { 241 target_os: "linux", 242 target_cpu: "x64", 243 dependencies: concat(common.dependencies, "devkit"), 244 configure_args: common.configure_args, 245 make_args: common.make_args 246 }, 247 248 "linux-x86": { 249 target_os: "linux", 250 target_cpu: "x86", 251 build_cpu: "x64", 252 dependencies: concat(common.dependencies, "devkit"), 253 configure_args: concat(common.configure_args, common.configure_args_32bit), 254 make_args: common.make_args 255 }, 256 257 "macosx-x64": { 258 target_os: "macosx", 259 target_cpu: "x64", 260 dependencies: concat(common.dependencies, "devkit"), 261 configure_args: common.configure_args, 262 make_args: common.make_args 263 }, 264 265 "solaris-x64": { 266 target_os: "solaris", 267 target_cpu: "x64", 268 dependencies: concat(common.dependencies, "devkit", "cups"), 269 configure_args: common.configure_args, 270 make_args: common.make_args 271 }, 272 273 "solaris-sparcv9": { 274 target_os: "solaris", 275 target_cpu: "sparcv9", 276 dependencies: concat(common.dependencies, "devkit", "cups"), 277 configure_args: common.configure_args, 278 make_args: common.make_args 279 }, 280 281 "windows-x64": { 282 target_os: "windows", 283 target_cpu: "x64", 284 dependencies: concat(common.dependencies, "devkit", "freetype"), 285 configure_args: common.configure_args, 286 make_args: common.make_args 287 }, 288 289 "windows-x86": { 290 target_os: "windows", 291 target_cpu: "x86", 292 build_cpu: "x64", 293 dependencies: concat(common.dependencies, "devkit", "freetype"), 294 configure_args: concat(common.configure_args, common.configure_args_32bit), 295 make_args: common.make_args 296 } 297 }; 298 profiles = concatObjects(profiles, mainProfiles); 299 // Generate debug versions of all the main profiles 300 profiles = concatObjects(profiles, generateDebugProfiles(common, mainProfiles)); 301 // Generate slowdebug versions of all the main profiles 302 profiles = concatObjects(profiles, generateSlowdebugProfiles(common, mainProfiles)); 303 304 // Generate open only profiles for all the main profiles for JPRT and reference 305 // implementation builds. 306 var openOnlyProfiles = generateOpenOnlyProfiles(common, mainProfiles); 307 // The open only profiles on linux are used for reference builds and should 308 // produce the compact profile images by default. 309 var openOnlyProfilesExtra = { 310 "linux-x64-open": { 311 configure_args: ["--with-default-make-target=all profiles"], 312 }, 313 314 "linux-x86-open": { 315 configure_args: ["--with-default-make-target=all profiles"], 316 } 317 }; 318 var openOnlyProfiles = concatObjects(openOnlyProfiles, openOnlyProfilesExtra); 319 320 profiles = concatObjects(profiles, openOnlyProfiles); 321 // Generate debug profiles for the open jprt profiles 322 profiles = concatObjects(profiles, generateDebugProfiles(common, openOnlyProfiles)); 323 324 // Profiles used to run tests. Used in JPRT. 325 var testOnlyProfiles = { 326 327 "run-test": { 328 target_os: input.build_os, 329 target_cpu: input.build_cpu, 330 dependencies: [ "jtreg", "gnumake" ], 331 labels: "test" 332 } 333 }; 334 profiles = concatObjects(profiles, testOnlyProfiles); 335 336 // Generate the missing platform attributes 337 profiles = generatePlatformAttributes(profiles); 338 return profiles; 339}; 340 341/** 342 * Generate the dependencies part of the configuration 343 * 344 * @param input External data to use for generating the configuration 345 * @param common The common values 346 * @returns {{}} Dependencies part of configuration 347 */ 348var getJibProfilesDependencies = function (input, common) { 349 350 var boot_jdk_platform = input.build_os + "-" 351 + (input.build_cpu == "x86" ? "i586" : input.build_cpu); 352 353 var devkit_platform_revisions = { 354 linux_x64: "gcc4.9.2-OEL6.4+1.0", 355 macosx_x64: "Xcode6.3-MacOSX10.9+1.0", 356 solaris_x64: "SS12u4-Solaris11u1+1.0", 357 solaris_sparcv9: "SS12u4-Solaris11u1+1.0", 358 windows_x64: "VS2013SP4+1.0" 359 }; 360 361 var devkit_platform = (input.target_cpu == "x86" 362 ? input.target_os + "_x64" 363 : input.target_platform); 364 365 var dependencies = { 366 367 boot_jdk: { 368 server: "javare", 369 module: "jdk", 370 revision: "8", 371 checksum_file: boot_jdk_platform + "/MD5_VALUES", 372 file: boot_jdk_platform + "/jdk-8-" + boot_jdk_platform + ".tar.gz", 373 configure_args: (input.build_os == "macosx" 374 ? "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0.jdk/Contents/Home" 375 : "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0") 376 }, 377 378 devkit: { 379 organization: common.organization, 380 ext: "tar.gz", 381 module: "devkit-" + devkit_platform, 382 revision: devkit_platform_revisions[devkit_platform] 383 }, 384 385 build_devkit: { 386 organization: common.organization, 387 ext: "tar.gz", 388 module: "devkit-" + input.build_platform, 389 revision: devkit_platform_revisions[input.build_platform] 390 }, 391 392 cups: { 393 organization: common.organization, 394 ext: "tar.gz", 395 revision: "1.0118+1.0" 396 }, 397 398 jtreg: { 399 server: "javare", 400 revision: "4.2", 401 build_number: "b01", 402 checksum_file: "MD5_VALUES", 403 file: "jtreg_bin-4.2.zip", 404 environment_name: "JT_HOME" 405 }, 406 407 gnumake: { 408 organization: common.organization, 409 ext: "tar.gz", 410 revision: "4.0+1.0", 411 412 module: (input.build_os == "windows" 413 ? "gnumake-" + input.build_osenv_platform 414 : "gnumake-" + input.build_platform), 415 416 configure_args: (input.build_os == "windows" 417 ? "MAKE=" + input.get("gnumake", "install_path") + "/cygwin/bin/make" 418 : "MAKE=" + input.get("gnumake", "install_path") + "/bin/make"), 419 420 environment_path: (input.build_os == "windows" 421 ? input.get("gnumake", "install_path") + "/cygwin/bin" 422 : input.get("gnumake", "install_path") + "/bin") 423 }, 424 425 freetype: { 426 organization: common.organization, 427 ext: "tar.gz", 428 revision: "2.3.4+1.0", 429 module: "freetype-" + input.target_platform 430 } 431 }; 432 433 return dependencies; 434}; 435 436/** 437 * Generate the missing platform attributes for profiles 438 * 439 * @param profiles Profiles map to generate attributes on 440 * @returns {{}} New profiles map with platform attributes fully filled in 441 */ 442var generatePlatformAttributes = function (profiles) { 443 var ret = concatObjects(profiles, {}); 444 for (var profile in profiles) { 445 if (ret[profile].build_os == null) { 446 ret[profile].build_os = ret[profile].target_os; 447 } 448 if (ret[profile].build_cpu == null) { 449 ret[profile].build_cpu = ret[profile].target_cpu; 450 } 451 ret[profile].target_platform = ret[profile].target_os + "_" + ret[profile].target_cpu; 452 ret[profile].build_platform = ret[profile].build_os + "_" + ret[profile].build_cpu; 453 } 454 return ret; 455}; 456 457/** 458 * Generates debug versions of profiles. Clones the given profiles and adds 459 * debug metadata. 460 * 461 * @param common Common values 462 * @param profiles Profiles map to generate debug profiles for 463 * @returns {{}} New map of profiles containing debug profiles 464 */ 465var generateDebugProfiles = function (common, profiles) { 466 var newProfiles = {}; 467 for (var profile in profiles) { 468 var debugProfile = profile + "-debug"; 469 newProfiles[debugProfile] = clone(profiles[profile]); 470 newProfiles[debugProfile].debug_level = "fastdebug"; 471 newProfiles[debugProfile].labels 472 = concat(newProfiles[debugProfile].labels || [], "debug"), 473 newProfiles[debugProfile].configure_args 474 = concat(newProfiles[debugProfile].configure_args, 475 common.configure_args_debug); 476 } 477 return newProfiles; 478}; 479 480/** 481 * Generates slowdebug versions of profiles. Clones the given profiles and adds 482 * debug metadata. 483 * 484 * @param common Common values 485 * @param profiles Profiles map to generate debug profiles for 486 * @returns {{}} New map of profiles containing debug profiles 487 */ 488var generateSlowdebugProfiles = function (common, profiles) { 489 var newProfiles = {}; 490 for (var profile in profiles) { 491 var debugProfile = profile + "-slowdebug"; 492 newProfiles[debugProfile] = clone(profiles[profile]); 493 newProfiles[debugProfile].debug_level = "slowdebug"; 494 newProfiles[debugProfile].labels 495 = concat(newProfiles[debugProfile].labels || [], "slowdebug"), 496 newProfiles[debugProfile].configure_args 497 = concat(newProfiles[debugProfile].configure_args, 498 common.configure_args_slowdebug); 499 } 500 return newProfiles; 501}; 502 503/** 504 * Generates open only versions of profiles. Clones the given profiles and adds 505 * open metadata. 506 * 507 * @param common Common values 508 * @param profiles Profiles map to generate open only profiles for 509 * @returns {{}} New map of profiles containing open only profiles 510 */ 511var generateOpenOnlyProfiles = function (common, profiles) { 512 var newProfiles = {}; 513 for (var profile in profiles) { 514 var openProfile = profile + "-open"; 515 newProfiles[openProfile] = clone(profiles[profile]); 516 newProfiles[openProfile].labels 517 = concat(newProfiles[openProfile].labels || [], "open"), 518 newProfiles[openProfile].configure_args 519 = concat(newProfiles[openProfile].configure_args, 520 "--enable-openjdk-only"); 521 } 522 return newProfiles; 523}; 524 525/** 526 * Deep clones an object tree. 527 * 528 * @param o Object to clone 529 * @returns {{}} Clone of o 530 */ 531var clone = function (o) { 532 return JSON.parse(JSON.stringify(o)); 533}; 534 535/** 536 * Concatenates all arguments into a new array 537 * 538 * @returns {Array.<T>} New array containing all arguments 539 */ 540var concat = function () { 541 return Array.prototype.concat.apply([], arguments); 542}; 543 544/** 545 * Copies all elements in an array into a new array but replacing all 546 * occurrences of original with replacement. 547 * 548 * @param original Element to look for 549 * @param replacement Element to replace with 550 * @param a Array to copy 551 * @returns {Array} New array with all occurrences of original replaced 552 * with replacement 553 */ 554var replace = function (original, replacement, a) { 555 var newA = []; 556 for (var i in a) { 557 if (original == a[i]) { 558 newA.push(replacement); 559 } else { 560 newA.push(a[i]); 561 } 562 } 563 return newA; 564}; 565 566/** 567 * Deep concatenation of two objects. For each node encountered, merge 568 * the contents with the corresponding node in the other object tree, 569 * treating all strings as array elements. 570 * 571 * @param o1 Object to concatenate 572 * @param o2 Object to concatenate 573 * @returns {{}} New object tree containing the concatenation of o1 and o2 574 */ 575var concatObjects = function (o1, o2) { 576 var ret = {}; 577 for (var a in o1) { 578 if (o2[a] == null) { 579 ret[a] = o1[a]; 580 } 581 } 582 for (var a in o2) { 583 if (o1[a] == null) { 584 ret[a] = o2[a]; 585 } else { 586 if (typeof o1[a] == 'string') { 587 ret[a] = [o1[a]].concat(o2[a]); 588 } else if (Array.isArray(o1[a])) { 589 ret[a] = o1[a].concat(o2[a]); 590 } else if (typeof o1[a] == 'object') { 591 ret[a] = concatObjects(o1[a], o2[a]); 592 } 593 } 594 } 595 return ret; 596}; 597