bobbai00 commented on code in PR #4367: URL: https://github.com/apache/texera/pull/4367#discussion_r3070968483
########## project/AddMetaInfLicenseFiles.scala: ########## @@ -0,0 +1,134 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +import sbt._ +import sbt.Keys._ +import com.typesafe.sbt.packager.universal.UniversalPlugin.autoImport._ + +/** + * Generates per-module LICENSE files for jar META-INF and dist zip top level. + * + * Each jar's META-INF/LICENSE describes only what is in that specific jar: + * - Modules without vendored code get Apache 2.0 only. + * - workflow-operator gets Apache 2.0 plus the mbknor-jackson-jsonschema + * attribution and the full MIT license text. + * + * NOTICE and DISCLAIMER are copied as-is from the repo root. + * + * See https://github.com/apache/texera/issues/4131 + */ +object AddMetaInfLicenseFiles { + + private lazy val rootDir = LocalRootProject / baseDirectory + + /** Extract the Apache 2.0 license text (before the THIRD-PARTY section) from root LICENSE. */ + private def apacheLicenseText(rootDir: File): String = { + val lines = IO.readLines(rootDir / "LICENSE") + val cutoffIndex = lines.zipWithIndex.collectFirst { + case (line, idx) if idx >= 200 && line.startsWith("---") => idx + }.getOrElse(lines.length) + lines.take(cutoffIndex).mkString("\n").trim + "\n" + } + + /** The vendored code section for workflow-operator (mbknor-jackson-jsonschema). */ + private def workflowOperatorVendoredSection(rootDir: File): String = { + val mitLicense = IO.read(rootDir / "licenses" / "LICENSE-MIT.txt") + s""" + |-------------------------------------------------------------------------------- + |THIRD-PARTY DEPENDENCIES + |-------------------------------------------------------------------------------- + | + |This jar bundles compiled code from the following third-party project. + |The full license text is included below. + | + |MIT License + |-------------------------------------- + | + |This product bundles code derived from mbknor-jackson-jsonschema: + | - com/kjetland/jackson/jsonSchema/ + | Copyright (c) 2016 Kjell Tore Eliassen (mbknor) + | Source: https://github.com/mbknor/mbknor-jackson-jsonschema + | + |-------------------------------------------------------------------------------- + |Full text of the MIT License: + |-------------------------------------------------------------------------------- + | + |${mitLicense.trim} + |""".stripMargin + } + + private def writeToMetaInf(managed: File, fileName: String, content: String): File = { + val dest = managed / "META-INF" / fileName + IO.write(dest, content) + dest + } + + private def copyToMetaInf(managed: File, src: File, fileName: String): File = { + val dest = managed / "META-INF" / fileName + IO.copyFile(src, dest) + dest + } + + private def noticeAndDisclaimer(managed: File, rootDir: File): Seq[File] = { + val files = Seq(copyToMetaInf(managed, rootDir / "NOTICE", "NOTICE")) + val disclaimer = rootDir / "DISCLAIMER" + if (disclaimer.exists()) files :+ copyToMetaInf(managed, disclaimer, "DISCLAIMER") + else files + } + + /** Settings for modules WITHOUT vendored third-party code. + * META-INF/LICENSE contains only the Apache 2.0 license text. */ + lazy val defaultSettings: Seq[Setting[_]] = Seq( + Compile / resourceGenerators += Def.task { + val managed = (Compile / resourceManaged).value + val root = rootDir.value + val licenseContent = apacheLicenseText(root) + writeToMetaInf(managed, "LICENSE", licenseContent) +: noticeAndDisclaimer(managed, root) + }.taskValue + ) + + /** Settings for workflow-operator which contains vendored mbknor-jackson-jsonschema code. + * META-INF/LICENSE contains Apache 2.0 plus the mbknor attribution and MIT license text. */ + lazy val workflowOperatorSettings: Seq[Setting[_]] = Seq( + Compile / resourceGenerators += Def.task { + val managed = (Compile / resourceManaged).value + val root = rootDir.value + val licenseContent = apacheLicenseText(root) + "\n" + workflowOperatorVendoredSection(root) + writeToMetaInf(managed, "LICENSE", licenseContent) +: noticeAndDisclaimer(managed, root) + }.taskValue + ) + + /** Additional settings for dist-producing modules: places the same files + * at the top level of the sbt-native-packager Universal zip so they + * appear alongside lib/ and bin/ in the distribution. */ + lazy val distSettings: Seq[Setting[_]] = Seq( + Universal / mappings := { + val existing = (Universal / mappings).value Review Comment: I think use := is better. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
