From 2614a1224fe1047232984b22a2098bca78d95064 Mon Sep 17 00:00:00 2001 From: Tomasz Pasternak Date: Fri, 22 Jan 2021 00:54:23 +0100 Subject: [PATCH] Build external api jar (#597) --- .github/workflows/build-test-jar.yml | 47 ++++ LICENSE | 10 + build-external-api-jar/.gitignore | 11 + build-external-api-jar/.sbtopts | 1 + build-external-api-jar/build.sbt | 14 ++ build-external-api-jar/intellij_license.txt | 202 ++++++++++++++++++ build-external-api-jar/intellij_notice.txt | 3 + .../project/Dependencies.scala | 26 +++ .../project/build.properties | 1 + build-external-api-jar/project/plugins.sbt | 2 + build-external-api-jar/run.sh | 30 +++ .../OpenProjectAndBuildArtifacts.conf | 41 ++++ .../tests/OpenProjectAndBuildArtifacts.scala | 166 ++++++++++++++ 13 files changed, 554 insertions(+) create mode 100644 .github/workflows/build-test-jar.yml create mode 100644 build-external-api-jar/.gitignore create mode 100644 build-external-api-jar/.sbtopts create mode 100644 build-external-api-jar/build.sbt create mode 100644 build-external-api-jar/intellij_license.txt create mode 100644 build-external-api-jar/intellij_notice.txt create mode 100644 build-external-api-jar/project/Dependencies.scala create mode 100644 build-external-api-jar/project/build.properties create mode 100644 build-external-api-jar/project/plugins.sbt create mode 100755 build-external-api-jar/run.sh create mode 100644 build-external-api-jar/tests/src/test/resources/OpenProjectAndBuildArtifacts.conf create mode 100644 build-external-api-jar/tests/src/test/scala/org/virtuslab/tests/OpenProjectAndBuildArtifacts.scala diff --git a/.github/workflows/build-test-jar.yml b/.github/workflows/build-test-jar.yml new file mode 100644 index 000000000..b40f856da --- /dev/null +++ b/.github/workflows/build-test-jar.yml @@ -0,0 +1,47 @@ +name: Build + +on: push + +env: + artifact_path: /tmp/external-system-test-api.zip + +jobs: + build: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v1 + - name: Prepare + run: sudo apt-get install openjdk-11-jdk xvfb + - name: Setup Scala + uses: olafurpg/setup-scala@v10 + with: + java-version: openjdk@1.11.0-2 + - name: Build external-system-test-api.jar' + run: ./build-external-api-jar/run.sh + - name: SHA256 + run: | + ls -l ${{ env.artifact_path }} + sha256sum ${{ env.artifact_path }} + - name: Create Release + if: startsWith(github.ref, 'refs/tags/external-system-test-api-v') + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ github.ref }} + release_name: Release ${{ github.ref }} + draft: false + prerelease: false + - name: Upload Release Asset + if: startsWith(github.ref, 'refs/tags/external-system-test-api-v') + id: upload-release-asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{ steps.create_release.outputs.upload_url }} + asset_path: ${{ env.artifact_path }} + asset_name: external-system-test-api.zip + asset_content_type: application/zip + diff --git a/LICENSE b/LICENSE index ac5d7e7ed..5c08f58fe 100644 --- a/LICENSE +++ b/LICENSE @@ -200,3 +200,13 @@ 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. + + +==================================================================== + +Code in this repository builds and contains the external-system-test-api.jar file which is built from parts of IntelliJ source code. +For more details, please check IntelliJ's repository https://github.com/JetBrains/intellij-community +According to IntelliJ's Apache license, we copy the LICENSE.txt and NOTICE.txt from the original source to this repository: + +The file intellij_notice.txt is from https://raw.githubusercontent.com/JetBrains/intellij-community/c04baf8730ec222de2e56e885d5e3ef5a2705ecc/NOTICE.txt +The file intellij_license.txt is from https://raw.githubusercontent.com/JetBrains/intellij-community/c04baf8730ec222de2e56e885d5e3ef5a2705ecc/LICENSE.txt diff --git a/build-external-api-jar/.gitignore b/build-external-api-jar/.gitignore new file mode 100644 index 000000000..e53398256 --- /dev/null +++ b/build-external-api-jar/.gitignore @@ -0,0 +1,11 @@ +.idea/ +dist/* +target/ +lib_managed/ +src_managed/ +project/boot/ +project/plugins/project/ +.history +.cache +.lib/ +*~ \ No newline at end of file diff --git a/build-external-api-jar/.sbtopts b/build-external-api-jar/.sbtopts new file mode 100644 index 000000000..428bd4088 --- /dev/null +++ b/build-external-api-jar/.sbtopts @@ -0,0 +1 @@ +-J-Xss2M diff --git a/build-external-api-jar/build.sbt b/build-external-api-jar/build.sbt new file mode 100644 index 000000000..74880c393 --- /dev/null +++ b/build-external-api-jar/build.sbt @@ -0,0 +1,14 @@ +name := "build-external-api-jar" + +version.in(ThisBuild) := "0.1" +scalaVersion.in(ThisBuild) := "2.13.1" +resolvers.in(ThisBuild) ++= Dependencies.ideProbe.resolvers +skip in publish := true + +lazy val tests = project + .in(file("tests")) + .settings( + name := "pants-tests", + libraryDependencies += Dependencies.ideProbe.jUnitDriver, + libraryDependencies ++= Dependencies.junit + ) diff --git a/build-external-api-jar/intellij_license.txt b/build-external-api-jar/intellij_license.txt new file mode 100644 index 000000000..345fb7797 --- /dev/null +++ b/build-external-api-jar/intellij_license.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2000-2018 JetBrains s.r.o. + + Licensed 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. diff --git a/build-external-api-jar/intellij_notice.txt b/build-external-api-jar/intellij_notice.txt new file mode 100644 index 000000000..d9f5e1dfc --- /dev/null +++ b/build-external-api-jar/intellij_notice.txt @@ -0,0 +1,3 @@ +This software includes code from IntelliJ IDEA Community Edition +Copyright (C) JetBrains s.r.o. +https://www.jetbrains.com/idea/ diff --git a/build-external-api-jar/project/Dependencies.scala b/build-external-api-jar/project/Dependencies.scala new file mode 100644 index 000000000..b1b7abbe0 --- /dev/null +++ b/build-external-api-jar/project/Dependencies.scala @@ -0,0 +1,26 @@ +import sbt._ + +object Dependencies { + val junit = Seq( + "junit" % "junit" % "4.12" % Test, + ("com.novocode" % "junit-interface" % "0.11" % Test).exclude("junit", "junit-dep") + ) + + object ideProbe { + + val version = "0.3.0+28-b36b0a51+20210114-1358-SNAPSHOT" + val resolvers = Seq( + Resolver.sonatypeRepo("public"), + Resolver.sonatypeRepo("snapshots"), + MavenRepository( + "jetbrains-3rd", + "https://jetbrains.bintray.com/intellij-third-party-dependencies") + ) + + def apply(name: String): ModuleID = { + "org.virtuslab.ideprobe" %% name % version + } + + val jUnitDriver = apply("junit-driver") + } +} diff --git a/build-external-api-jar/project/build.properties b/build-external-api-jar/project/build.properties new file mode 100644 index 000000000..302b6be1f --- /dev/null +++ b/build-external-api-jar/project/build.properties @@ -0,0 +1 @@ +sbt.version = 1.3.13 \ No newline at end of file diff --git a/build-external-api-jar/project/plugins.sbt b/build-external-api-jar/project/plugins.sbt new file mode 100644 index 000000000..c6b578422 --- /dev/null +++ b/build-external-api-jar/project/plugins.sbt @@ -0,0 +1,2 @@ +addSbtPlugin("org.jetbrains" % "sbt-idea-plugin" % "3.7.0") +addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.9.0") diff --git a/build-external-api-jar/run.sh b/build-external-api-jar/run.sh new file mode 100755 index 000000000..a800d3e85 --- /dev/null +++ b/build-external-api-jar/run.sh @@ -0,0 +1,30 @@ +#!/bin/bash +# IDEA_VERSION=202.6109.22 +# IDEA_SHA=b8d2a1567fc29fa7514666aead10e70b23f2f94b301e489817a01ed34f5e46d3 + +IDEA_VERSION=203.5981.114 +IDEA_SHA=94b17f42465b8f2af7bc8b9bf0ced1b9989877596d1c2758e4104b089b931b55 +SOURCES_DIR="/tmp/idea-sources" +DIR=$(realpath $(dirname "${BASH_SOURCE[0]}")) +GIT_ROOT=$DIR/.. + +set -e +( + cd /tmp + curl -L "https://github.com/JetBrains/intellij-community/archive/idea/${IDEA_VERSION}.zip" -o idea.zip + echo "$IDEA_SHA idea.zip" | sha256sum -c - && unzip -q idea.zip + mv "/tmp/intellij-community-idea-${IDEA_VERSION}" $SOURCES_DIR +) +( + cd $DIR + export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 + export IDEPROBE_DISPLAY=xvfb + sbt test +) +( + cd /tmp + cp $SOURCES_DIR/LICENSE.txt intellij_license.txt + cp $SOURCES_DIR/NOTICE.txt intellij_notice.txt + cp "$GIT_ROOT/LICENSE" license_from_build_project.txt + zip -xi external-system-test-api.zip -xi external-system-test-api.jar intellij_notice.txt intellij_license.txt license_from_build_project.txt +) diff --git a/build-external-api-jar/tests/src/test/resources/OpenProjectAndBuildArtifacts.conf b/build-external-api-jar/tests/src/test/resources/OpenProjectAndBuildArtifacts.conf new file mode 100644 index 000000000..df75858cb --- /dev/null +++ b/build-external-api-jar/tests/src/test/resources/OpenProjectAndBuildArtifacts.conf @@ -0,0 +1,41 @@ +versions { + intellij { + build = "203.5981.41" + release = "2020.3" + } +} + +probe { + workspace.path = "/tmp/idea-sources" + endpoints.awaitIdle = { + initialWait = "5 seconds" + newTaskWait = "2 seconds" + checkFrequency = "10 seconds" + active = false + } + + driver { + launch.timeout = "2 minutes" + vmOptions = [ + "-Dvcs.log.index.git=false", + "-Dgit.process.ignored=false", + "-Ddotty.highlighting.compiler.errors.in.editor=false", + "-Dvcs.root.detector.folder.depth=1", + "-Xms2g", + "-XX:MaxMetaspaceSize=768M", + "-XX:MetaspaceSize=256M", + "-XX:ReservedCodeCacheSize=512m", + "-XX:+UseConcMarkSweepGC", + "-XX:CMSInitiatingOccupancyFraction=85", + "-XX:+UseCMSInitiatingOccupancyOnly", + "-XX:+ExplicitGCInvokesConcurrent", + "-XX:+CMSScavengeBeforeRemark", + "-XX:+IgnoreUnrecognizedVMOptions" + ] + } + + intellij { + version = ${versions.intellij} + } +} + diff --git a/build-external-api-jar/tests/src/test/scala/org/virtuslab/tests/OpenProjectAndBuildArtifacts.scala b/build-external-api-jar/tests/src/test/scala/org/virtuslab/tests/OpenProjectAndBuildArtifacts.scala new file mode 100644 index 000000000..866b920d7 --- /dev/null +++ b/build-external-api-jar/tests/src/test/scala/org/virtuslab/tests/OpenProjectAndBuildArtifacts.scala @@ -0,0 +1,166 @@ +package org.virtuslab.tests + +import org.junit.Test +import org.virtuslab.ideprobe.junit4.IdeProbeTestSuite +import org.virtuslab.ideprobe.ProbeExtensions + +import java.nio.file.Paths + +object OpenProjectAndBuildArtifacts +{ + val jdkDef = { + """ + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + | + """.stripMargin + } + val artifactVal = + """ + | + | + | $PROJECT_DIR$/out/artifacts/external_system_test_api + | + | + | + | + | + | + | + |""".stripMargin +} + + +class OpenProjectAndBuildArtifacts extends IdeProbeTestSuite with ProbeExtensions { + + import OpenProjectAndBuildArtifacts._ + + registerFixtureTransformer( + _.withAfterIntelliJInstall{ (_, installedIntelliJ) => + installedIntelliJ.paths.config.resolve( "options/jdk.table.xml" ).write(OpenProjectAndBuildArtifacts.jdkDef) + } + ) + registerFixtureTransformer( + _.withAfterWorkspaceSetup{(_, path) => + path.resolve(".idea/artifacts/external_system_test_api.xml").write(artifactVal) + } + ) + + @Test def build: Unit = fixtureFromConfig().run { intelliJ => + val project = intelliJ.probe.openProject(intelliJ.workspace) + Thread.sleep(10*1000) + + def waitUntilTrueForAllTasks(predicate: Seq[String] => Boolean) = { + var scanning = false + while (!scanning) { + val tasks = intelliJ.probe.backgroundTasks + if (predicate(tasks)) scanning = true + Thread.sleep(1000) + } + } + + waitUntilTrueForAllTasks(_.exists(_.contains("Updating indexes"))) + intelliJ.probe.buildArtifact(project, "external-system-test-api") + waitUntilTrueForAllTasks(_.exists(_.contains("Build"))) + waitUntilTrueForAllTasks(_.forall(!_.contains("Build"))) + intelliJ.workspace.resolve("out/artifacts/external_system_test_api/external-system-test-api.jar").copyTo(Paths.get("/tmp/external-system-test-api.jar")) + } +}