Scooping up last buildAccess references, making the profile system more defaulty and readme tweaks

Enquier · Enquier · commit eec3cc993325 · 2021-11-09T15:36:23.000-07:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -48,7 +48,7 @@ jobs:
 
       - run:
           name: Compile
-          command: ./gradlew --refresh-dependencies --info --stacktrace -PbuildAccess=opensource clean assemble
+          command: ./gradlew --refresh-dependencies --info --stacktrace clean assemble
         
 #      # Test
 #      - run:
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -8,7 +8,7 @@ pipeline {
         GRADLE_USER_HOME = "$WORKSPACE/.gradle"
         ARTIFACTORY_CREDENTIALS = credentials('mdk-artifactory-credentials')
         TESTRAIL_CREDENTIALS = credentials('mdk-testrail-credentials')
-        BUILD_ACCESS = credentials('mdk-build-access')
+        BUILD_PROFILE = credentials('mdk-build-access')
         TESTRAIL_HOST = credentials('mdk-testrail-host')
         TESTRAIL_SUITE_ID = credentials('mdk-testrail-suite-id')
         ARTIFACTORY_URL = credentials('mdk-artifactory-url')
@@ -21,7 +21,7 @@ pipeline {
                 echo 'TAG_NAME = $TAG_NAME'
                 sh './gradlew \
                     -PbuildNumber=$BUILD_NUMBER \
-                    -PbuildAccess=$BUILD_ACCESS \
+                    -PbuildProfile=$BUILD_PROFILE \
                     -PbuildTag=$TAG_NAME \
                     -PartifactoryUrl=$ARTIFACTORY_URL \
                     -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -35,7 +35,7 @@ pipeline {
             steps {
                 sh './gradlew \
                     -PbuildNumber=$BUILD_NUMBER \
-                    -PbuildAccess=$BUILD_ACCESS \
+                    -PbuildProfile=$BUILD_PROFILE \
                     -PbuildTag=$TAG_NAME \
                     -PartifactoryUrl=$ARTIFACTORY_URL \
                     -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -49,7 +49,7 @@ pipeline {
             steps {
                 sh 'xvfb-run ./gradlew \
                     -PbuildNumber=$BUILD_NUMBER \
-                    -PbuildAccess=$BUILD_ACCESS \
+                    -PbuildProfile=$BUILD_PROFILE \
                     -PbuildTag=$TAG_NAME \
                     -PartifactoryUrl=$ARTIFACTORY_URL \
                     -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -69,7 +69,7 @@ pipeline {
             steps {
                 sh './gradlew \
                 -PbuildNumber=$BUILD_NUMBER \
-                -PbuildAccess=$BUILD_ACCESS \
+                -PbuildProfile=$BUILD_PROFILE \
                 -PbuildTag=$TAG_NAME \
                 -PartifactoryUrl=$ARTIFACTORY_URL \
                 -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
@@ -86,7 +86,7 @@ pipeline {
             steps {
                 sh './gradlew \
                 -PbuildNumber=$BUILD_NUMBER \
-                -PbuildAccess=$BUILD_ACCESS \
+                -PbuildProfile=$BUILD_PROFILE \
                 -PbuildTag=$TAG_NAME \
                 -PartifactoryUrl=$ARTIFACTORY_URL \
                 -PartifactoryUsername=$ARTIFACTORY_CREDENTIALS_USR \
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Cameo MDK is a plugin for [Cameo Systems Modeler](https://www.nomagic.com/produc
 ## Prerequisites
 
 * [Cameo Systems Modeler (CSM)](https://www.nomagic.com/products/cameo-systems-modeler) or another No Magic environment bundle that includes the [SysML plugin](https://www.nomagic.com/product-addons/magicdraw-addons/sysml-plugin)
-    * The latest Cameo MDK is tested with and supports **19.0 SP4**. Compatibility for previous versions of Cameo MDK can be found in the [compatibility matrices](https://github.com/Open-MBEE/open-mbee.github.io/wiki/Compatibilities).
+    * The latest Cameo MDK is tested with and supports **19.0 SP3** and **19.0 SP4** (you must use a custom profile for SP4). Compatibility for previous versions of Cameo MDK can be found in the [compatibility matrices](https://github.com/Open-MBEE/open-mbee.github.io/wiki/Compatibilities).
 #### Versions prior to 5.x:
 * [Model Management System (MMS) 3](https://github.com/Open-MBEE/mms-alfresco)
 #### Version 5.0+
@@ -19,8 +19,8 @@ Cameo MDK is a plugin for [Cameo Systems Modeler](https://www.nomagic.com/produc
 
 1. [Download](https://github.com/Open-MBEE/mdk/releases/latest) the Cameo MDK plugin, e.g. `mdk-*-plugin.zip`.
 
-    *Note: Make sure you are downloading the correct version for your installation of MMS (for mms-alfresco (mms3/donbot) use
-    version 4.5.x, for mms (mms4/execubots) use versions 5.0+)*
+    >**Note:** *Make sure you are downloading the correct version for your installation of MMS (for mms-alfresco (mms3/donbot) use
+    >version 4.5.x, for mms (mms4/execubots) use versions 5.0+)*
 
 2. Run CSM. From the main menu, select "Help" > "Resource/Plugin Manager".
    ![Resource/Plugin Manager](doc/images/resource-plugin-manager.png)
@@ -48,15 +48,32 @@ To learn how you can get involved in a variety of ways, please see [Contibuting
 
 Cameo MDK is a Java project that uses the [Gradle](https://gradle.org/) build tool. It can be imported as a Gradle project in IDEs like [IntelliJ](https://www.jetbrains.com/idea/) and [Eclipse](https://www.eclipse.org/ide/).
 
-## Common Tasks
-*Note starting in version 5.0 you will need to define a build profile (in `./buildProfiles`) which will house the classpath
-for your particular version of cameo. In order to retrieve this classpath, copy paste the CLASSPATH entry from your 
-`${md.install.dir}/bin/(magicraw/csm/cea).properties` file. Copy the entire line into a new file and find replace the `\:`
-with `,` for more information refer to the existing `buildProfiles/opensource.properties`. Also, note that that profile should
-work for most 19.0sp3 installations.*
 
-In order to use your custom profile run any of the below commands with `-PbuildAccess=<yourProfileName>` otherwise it will
-default to using `opensource`.
+## Custom Build Profiles
+Starting with version 5.0+ you will be able to define custom build profiles (in `./buildProfiles`) which will house 
+the classpath and other variables previously managed by setting `-buildAccess=internal`. These profiles will allow
+customization based on your build process and for your particular version of Cameo. 
+
+**NOTE:** By default build profiles are excluded from being committed to git by a `buildProfiles/.gitignore`
+
+### Create a new profile
+Create a new java properties file in `buildProfiles/<yourProfileName>.properties`.
+In order to use a custom profile to run any of the below commands. Use the command with `-PbuildProfile=<yourProfileName>`
+> For more examples of what properties are available in profiles see the example file in `buildProfiles/example.properties`
+
+### For users of non-standard cameo bundles
+To retrieve the classpath:
+1. Copy the CLASSPATH entry from your `${md.install.dir}/bin/(magicraw/csm/cea).properties` file. 
+2. Paste the entire line into a new file and find replace the `\:` with `,` and set it equal to `classpath`
+3. Save this file to `buildProfiles/<yourProfileName>.properties`
+> This is only necessary for custom build repositories or non-SP3 builds, most users will not need to modify the classpath
+> and modification of the classpath is not necessary to use profiles!
+
+
+
+## Build
+>In order to use a custom profile to run any of the below commands. Use the command with `-PbuildProfile=<yourProfileName>` otherwise it will
+>default to using `opensource`.
 
 * `./gradlew dependencies` will download all necessary dependencies.
 * `./gradlew assemble` will compile Cameo MDK from source.
diff --git a/build.gradle b/build.gradle
@@ -5,7 +5,7 @@ import java.util.zip.ZipFile
 import groovy.json.JsonSlurper;
 
 
-String buildAccess = project.getProperties().getOrDefault('buildAccess', 'opensource')
+String buildProfile = project.getProperties().getOrDefault('buildProfile', 'opensource')
 String buildTag = project.getProperties().get('buildTag')
 if (buildTag != null && !buildTag.isEmpty() && buildTag != version) {
     throw new GradleException('Version mismatch: '+buildTag+' vs '+version)
@@ -16,22 +16,37 @@ if ((buildTag == null || buildTag.isEmpty()) && !version.endsWith('-SNAPSHOT'))
 
 def profiles = new Properties()
 def parser = new JsonSlurper()
-try {
-    file("buildProfiles/" + buildAccess + ".properties").withInputStream { profiles.load(it) }
-} catch (FileNotFoundException e) {
-    println "Profile Properties File not found using default:" + e.message
-    file("buildProfiles/opensource.properties").withInputStream { profiles.load(it) }
+def defaults = new Properties()
+file("buildProfiles/opensource.properties").withInputStream { defaults.load(it) }
+
+if (buildProfile != 'opensource') {
+    try {
+        file("buildProfiles/" + buildProfile + ".properties").withInputStream { profiles.load(it) }
+    } catch (FileNotFoundException e) {
+        println "Profile Properties File not found using default:" + e.message
+        file("buildProfiles/opensource.properties").withInputStream { profiles.load(it) }
+    }
+}
+else{
+    profiles = defaults
 }
 
+
+
 if (profiles['group'] != null) {
     group = group.replace('org.openmbee', profiles['group'])
 }
 String buildNumber = project.hasProperty('buildNumber') ? project.getProperty('buildNumber') : System.currentTimeSeconds()
 String timestamp = DateTimeFormatter.ofPattern("yyyy-MM-dd-HH:mm").format(LocalDateTime.now())
 
-// classpathLibraries as defined in bin/[magicdraw|csm].properties#CLASSPATH are stored in ./buildProfiles
+String[] classpathLibraries = null
+if (profiles['classpathLibraries'] != null) {
+    classpathLibraries = profiles["classpathLibraries"].toString().split(',')
+}
+else{
+    classpathLibraries = defaults["classpathLibraries"].toString().split(',')
+}
 
-String[] classpathLibraries = profiles["classpathLibraries"].toString().split(',')
 
 String docbookNameVersion = 'docbook-xsl-1.79.1'
 String fopNameVersion = 'fop-1.1'
@@ -98,6 +113,12 @@ if (profiles['repositories'] != null) {
             def ivyRepo = it
             repositories.ivy {
                 url "${ivyRepo.url}"
+                if (ivyRepo.credentials == true) {
+                    credentials {
+                        username project.getProperties().get('artifactoryUsername')
+                        password project.getProperties().get('artifactoryPassword')
+                    }
+                }
                 layout "${ivyRepo.layout.type}", {
                     artifact '' + ivyRepo.layout.pattern
                 }
diff --git a/buildProfiles/example.properties b/buildProfiles/example.properties
diff --git a/lgtm.yml b/lgtm.yml
