jib-profiles.js revision 1943:2436705f4a75
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 organization: "jpg.infra.builddeps" 221 }; 222 223 return common; 224}; 225 226/** 227 * Generates the profiles part of the configuration. 228 * 229 * @param input External data to use for generating the configuration 230 * @param common The common values 231 * @returns {{}} Profiles part of the configuration 232 */ 233var getJibProfilesProfiles = function (input, common) { 234 var profiles = {}; 235 236 // Main SE profiles 237 var mainProfiles = { 238 239 "linux-x64": { 240 target_os: "linux", 241 target_cpu: "x64", 242 dependencies: concat(common.dependencies, "devkit"), 243 configure_args: common.configure_args, 244 make_args: common.make_args 245 }, 246 247 "linux-x86": { 248 target_os: "linux", 249 target_cpu: "x86", 250 build_cpu: "x64", 251 dependencies: concat(common.dependencies, "devkit"), 252 configure_args: concat(common.configure_args, common.configure_args_32bit), 253 make_args: common.make_args 254 }, 255 256 "macosx-x64": { 257 target_os: "macosx", 258 target_cpu: "x64", 259 dependencies: concat(common.dependencies, "devkit"), 260 configure_args: common.configure_args, 261 make_args: common.make_args 262 }, 263 264 "solaris-x64": { 265 target_os: "solaris", 266 target_cpu: "x64", 267 dependencies: concat(common.dependencies, "devkit", "cups"), 268 configure_args: common.configure_args, 269 make_args: common.make_args 270 }, 271 272 "solaris-sparcv9": { 273 target_os: "solaris", 274 target_cpu: "sparcv9", 275 dependencies: concat(common.dependencies, "devkit", "cups"), 276 configure_args: common.configure_args, 277 make_args: common.make_args 278 }, 279 280 "windows-x64": { 281 target_os: "windows", 282 target_cpu: "x64", 283 dependencies: concat(common.dependencies, "devkit", "freetype"), 284 configure_args: common.configure_args, 285 make_args: common.make_args 286 }, 287 288 "windows-x86": { 289 target_os: "windows", 290 target_cpu: "x86", 291 build_cpu: "x64", 292 dependencies: concat(common.dependencies, "devkit", "freetype"), 293 configure_args: concat(common.configure_args, common.configure_args_32bit), 294 make_args: common.make_args 295 } 296 }; 297 profiles = concatObjects(profiles, mainProfiles); 298 // Generate debug versions of all the main profiles 299 profiles = concatObjects(profiles, generateDebugProfiles(common, mainProfiles)); 300 301 // Specific open profiles needed for JPRT testing 302 var jprtOpenProfiles = { 303 304 "linux-x64-open": { 305 target_os: mainProfiles["linux-x64"].target_os, 306 target_cpu: mainProfiles["linux-x64"].target_cpu, 307 dependencies: mainProfiles["linux-x64"].dependencies, 308 configure_args: concat(mainProfiles["linux-x64"].configure_args, 309 "--enable-openjdk-only"), 310 make_args: mainProfiles["linux-x64"].make_args, 311 labels: [ "open" ] 312 }, 313 314 "linux-x86-open": { 315 target_os: mainProfiles["linux-x86"].target_os, 316 target_cpu: mainProfiles["linux-x86"].target_cpu, 317 dependencies: mainProfiles["linux-x86"].dependencies, 318 configure_args: concat(mainProfiles["linux-x86"].configure_args, 319 "--enable-openjdk-only"), 320 make_args: mainProfiles["linux-x86"].make_args, 321 labels: [ "open" ] 322 }, 323 324 "solaris-x64-open": { 325 target_os: mainProfiles["solaris-x64"].target_os, 326 target_cpu: mainProfiles["solaris-x64"].target_cpu, 327 dependencies: mainProfiles["solaris-x64"].dependencies, 328 configure_args: concat(mainProfiles["solaris-x64"].configure_args, 329 "--enable-openjdk-only"), 330 make_args: mainProfiles["solaris-x64"].make_args, 331 labels: [ "open" ] 332 }, 333 334 "windows-x86-open": { 335 target_os: mainProfiles["windows-x86"].target_os, 336 target_cpu: mainProfiles["windows-x86"].target_cpu, 337 dependencies: mainProfiles["windows-x86"].dependencies, 338 configure_args: concat(mainProfiles["windows-x86"].configure_args, 339 "--enable-openjdk-only"), 340 make_args: mainProfiles["windows-x86"].make_args, 341 labels: [ "open" ] 342 } 343 }; 344 profiles = concatObjects(profiles, jprtOpenProfiles); 345 // Generate debug profiles for the open jprt profiles 346 profiles = concatObjects(profiles, generateDebugProfiles(common, jprtOpenProfiles)); 347 348 // Profiles used to run tests. Used in JPRT. 349 var testOnlyProfiles = { 350 351 "run-test": { 352 target_os: input.build_os, 353 target_cpu: input.build_cpu, 354 dependencies: [ "jtreg", "gnumake" ], 355 labels: "test" 356 } 357 }; 358 profiles = concatObjects(profiles, testOnlyProfiles); 359 360 // Generate the missing platform attributes 361 profiles = generatePlatformAttributes(profiles); 362 return profiles; 363}; 364 365/** 366 * Generate the dependencies part of the configuration 367 * 368 * @param input External data to use for generating the configuration 369 * @param common The common values 370 * @returns {{}} Dependencies part of configuration 371 */ 372var getJibProfilesDependencies = function (input, common) { 373 374 var boot_jdk_platform = input.build_os + "-" 375 + (input.build_cpu == "x86" ? "i586" : input.build_cpu); 376 377 var devkit_platform_revisions = { 378 linux_x64: "gcc4.9.2-OEL6.4+1.0", 379 macosx_x64: "Xcode6.3-MacOSX10.9+1.0", 380 solaris_x64: "SS12u4-Solaris11u1+1.0", 381 solaris_sparcv9: "SS12u4-Solaris11u1+1.0", 382 windows_x64: "VS2013SP4+1.0" 383 }; 384 385 var devkit_platform = (input.target_cpu == "x86" 386 ? input.target_os + "_x64" 387 : input.target_platform); 388 389 var dependencies = { 390 391 boot_jdk: { 392 server: "javare", 393 module: "jdk", 394 revision: "8", 395 checksum_file: boot_jdk_platform + "/MD5_VALUES", 396 file: boot_jdk_platform + "/jdk-8-" + boot_jdk_platform + ".tar.gz", 397 configure_args: (input.build_os == "macosx" 398 ? "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0.jdk/Contents/Home" 399 : "--with-boot-jdk=" + input.get("boot_jdk", "install_path") + "/jdk1.8.0") 400 }, 401 402 devkit: { 403 organization: common.organization, 404 ext: "tar.gz", 405 module: "devkit-" + devkit_platform, 406 revision: devkit_platform_revisions[devkit_platform] 407 }, 408 409 build_devkit: { 410 organization: common.organization, 411 ext: "tar.gz", 412 module: "devkit-" + input.build_platform, 413 revision: devkit_platform_revisions[input.build_platform] 414 }, 415 416 cups: { 417 organization: common.organization, 418 ext: "tar.gz", 419 revision: "1.0118+1.0" 420 }, 421 422 jtreg: { 423 server: "javare", 424 revision: "4.1", 425 build_number: "b12", 426 checksum_file: "MD5_VALUES", 427 file: "jtreg_bin-4.1.zip", 428 environment_name: "JT_HOME" 429 }, 430 431 gnumake: { 432 organization: common.organization, 433 ext: "tar.gz", 434 revision: "4.0+1.0", 435 436 module: (input.build_os == "windows" 437 ? "gnumake-" + input.build_osenv_platform 438 : "gnumake-" + input.build_platform), 439 440 configure_args: (input.build_os == "windows" 441 ? "MAKE=" + input.get("gnumake", "install_path") + "/cygwin/bin/make" 442 : "MAKE=" + input.get("gnumake", "install_path") + "/bin/make"), 443 444 environment_path: (input.build_os == "windows" 445 ? input.get("gnumake", "install_path") + "/cygwin/bin" 446 : input.get("gnumake", "install_path") + "/bin") 447 }, 448 449 freetype: { 450 organization: common.organization, 451 ext: "tar.gz", 452 revision: "2.3.4+1.0", 453 module: "freetype-" + input.target_platform 454 } 455 }; 456 457 return dependencies; 458}; 459 460/** 461 * Generate the missing platform attributes for profiles 462 * 463 * @param profiles Profiles map to generate attributes on 464 * @returns {{}} New profiles map with platform attributes fully filled in 465 */ 466var generatePlatformAttributes = function (profiles) { 467 var ret = concatObjects(profiles, {}); 468 for (var profile in profiles) { 469 if (ret[profile].build_os == null) { 470 ret[profile].build_os = ret[profile].target_os; 471 } 472 if (ret[profile].build_cpu == null) { 473 ret[profile].build_cpu = ret[profile].target_cpu; 474 } 475 ret[profile].target_platform = ret[profile].target_os + "_" + ret[profile].target_cpu; 476 ret[profile].build_platform = ret[profile].build_os + "_" + ret[profile].build_cpu; 477 } 478 return ret; 479}; 480 481/** 482 * Generates debug versions of profiles. Clones the given profiles and adds 483 * debug metadata. 484 * 485 * @param common Common values 486 * @param profiles Profiles map to generate debug profiles for 487 * @returns {{}} New map of profiles containing debug profiles 488 */ 489var generateDebugProfiles = function (common, profiles) { 490 var newProfiles = {}; 491 for (var profile in profiles) { 492 var debugProfile = profile + "-debug"; 493 newProfiles[debugProfile] = clone(profiles[profile]); 494 newProfiles[debugProfile].debug_level = "fastdebug"; 495 newProfiles[debugProfile].labels 496 = concat(newProfiles[debugProfile].labels || [], "debug"), 497 newProfiles[debugProfile].configure_args 498 = concat(newProfiles[debugProfile].configure_args, 499 common.configure_args_debug); 500 } 501 return newProfiles; 502}; 503 504/** 505 * Deep clones an object tree. 506 * 507 * @param o Object to clone 508 * @returns {{}} Clone of o 509 */ 510var clone = function (o) { 511 return JSON.parse(JSON.stringify(o)); 512}; 513 514/** 515 * Concatenates all arguments into a new array 516 * 517 * @returns {Array.<T>} New array containing all arguments 518 */ 519var concat = function () { 520 return Array.prototype.concat.apply([], arguments); 521}; 522 523/** 524 * Copies all elements in an array into a new array but replacing all 525 * occurrences of original with replacement. 526 * 527 * @param original Element to look for 528 * @param replacement Element to replace with 529 * @param a Array to copy 530 * @returns {Array} New array with all occurrences of original replaced 531 * with replacement 532 */ 533var replace = function (original, replacement, a) { 534 var newA = []; 535 for (var i in a) { 536 if (original == a[i]) { 537 newA.push(replacement); 538 } else { 539 newA.push(a[i]); 540 } 541 } 542 return newA; 543}; 544 545/** 546 * Deep concatenation of two objects. For each node encountered, merge 547 * the contents with the corresponding node in the other object tree, 548 * treating all strings as array elements. 549 * 550 * @param o1 Object to concatenate 551 * @param o2 Object to concatenate 552 * @returns {{}} New object tree containing the concatenation of o1 and o2 553 */ 554var concatObjects = function (o1, o2) { 555 var ret = {}; 556 for (var a in o1) { 557 if (o2[a] == null) { 558 ret[a] = o1[a]; 559 } 560 } 561 for (var a in o2) { 562 if (o1[a] == null) { 563 ret[a] = o2[a]; 564 } else { 565 if (typeof o1[a] == 'string') { 566 ret[a] = [o1[a]].concat(o2[a]); 567 } else if (Array.isArray(o1[a])) { 568 ret[a] = o1[a].concat(o2[a]); 569 } else if (typeof o1[a] == 'object') { 570 ret[a] = concatObjects(o1[a], o2[a]); 571 } 572 } 573 } 574 return ret; 575}; 576