Features/8 use assembly settings (#9)

* Use the assembly output as input for our plugin

* Update readme, release notes, and descriptions of settings keys

* Setting version to 0.4.0

* Setting version to 0.4.1-SNAPSHOT

Co-authored-by: Jean-Marc van Leerdam <jean-marc.van.leerdam@ordina.nl>

Author: jeanmarc

README.md

@@ -20,9 +20,9 @@ Experimental plugin for sbt to create Azure Function artefacts (function.json) n
         .settings(
             ...
 
-            azfunZipName := "myFunctions",
-            azfunJarName := "ScalaFunctions",
-            assemblyOutputPath in assembly := azfunTargetFolder.value / s"${azfunJarName.value}.jar",
+            // optional: override the zip and/or jar name (defaults are AzureFunction.zip and AzureFunction.jar)
+            azfunZipName := "myFunctions.zip",
+            azfunJarName := "ScalaFunctions.jar",
         
             // you need this dependency to be able to use the annotations
             libraryDependencies ++= Seq(
@@ -42,14 +42,13 @@ Experimental plugin for sbt to create Azure Function artefacts (function.json) n
     The `azfunCreateZipFile` task will automatically trigger the following intermediate tasks that could also be
     called individually:
 
-    * `azfunGenerateFunctionJsons` - to make the `function.json` files
+    * `azfunGenerateFunctionJsons` - to make the `function.json` files (implicitly calls `assembly` task)
     * `azfunCopyHostJson` - to copy the `host.json` file
     * `azfunCopyLocalSettingsJson` - to copy the `local.settings.json` file
 
 ## TODO: 
 1. add task to upload to Azure
 1. add tests against multiple Java versions (java 8 and Java 11)
-1. remove setting `azfunJarName` (and related folder settings) and use the `assembly.value` instead
 
 
 ## Cross compiling and testing
@@ -79,10 +78,9 @@ For now I will use these versions
 #### Unit tests
 * `sbt clean test`
 #### Scripted tests
-* `sbt publishLocal scripted`
-  (the publishLocal is needed to ensure the latest snapshot of the library is available to the plugin)
+* `sbt scripted`
 
-## Releasing
+## Releasing (for plugin maintainers)
 To release a new version:
 * Get a [bintray](https://bintray.com) account and make sure you're a member of the [`code-star`](https://bintray.com/code-star) organization.
 * Set your credentials - you can use `sbt bintrayChangeCredentials`, but when run from the interactive sbt prompt
@@ -91,5 +89,5 @@ To release a new version:
 
     (found a workaround that shows the prompt again: add to build.sbt: `ThisBuild / useSuperShell := false`)
 * reload to make new settings known to sbt
-* Run `sbt publishLocal release`
+* Run `sbt release`
 

plugin/src/main/scala/sbtazurefunctions/AzureFunctions.scala

@@ -16,11 +16,11 @@ object AzureFunctionsKeys {
   val azfunHostJsonFile =
     settingKey[File]("Location of the host.json file")
   val azfunJarName =
-    settingKey[String]("Name of the jar that holds the function definitions (without extension)")
+    settingKey[String]("Name of the jar that holds the function definitions (default: AzureFunction.jar)")
   val azfunLocalSettingsFile =
     settingKey[File]("Location of the local.settings.json")
   val azfunZipName =
-    settingKey[String]("Name of the zip file that will contain the results (without extension)")
+    settingKey[String]("Name of the zip file that will contain the results (default: AzureFunction.zip)")
 
   val azfunCreateZipFile = taskKey[File](
     "Generate the zip file containing the complete Azure Function definition"
@@ -50,7 +50,8 @@ object AzureFunctions extends AutoPlugin {
     azfunHostJsonFile := (baseDirectory in Compile).value / "host.json",
     azfunLocalSettingsFile := (baseDirectory in Compile).value / "local.settings.json",
     azfunTargetFolder := (target in Compile).value / azfunZipName.value,
-    azfunZipName := "AzureFunction",
+    azfunZipName := "AzureFunction.zip",
+    azfunJarName := "AzureFunction.jar",
     azfunCopyHostJson := {
       val log = sbt.Keys.streams.value.log
       val folder = azfunTargetFolder.value
@@ -105,23 +106,27 @@ object AzureFunctions extends AutoPlugin {
       )
 
       val src = azfunTargetFolder.value
-      val tgt = tgtFolder / s"${azfunZipName.value}.zip"
+      val tgt = tgtFolder / azfunZipName.value
       IO.zip(allSubpaths(src), tgt)
       tgt
     },
     azfunGenerateFunctionJsons := {
       // depend on assembly step
-      val _ = assembly.value
+      val assemblyJar = assembly.value
       val log = sbt.Keys.streams.value.log
 
       val folder = azfunTargetFolder.value
 
       log.info("Running azureFunctions task...")
       log.info(s"Generating function.json files to $folder ...")
 
-      val fatJarFile = azfunTargetFolder.value / s"${azfunJarName.value}.jar"
-      val urls =
-        ClasspathHelper.forManifest(fatJarFile.toURI.toURL).asScala.toList
+      val fatJarFile = folder / azfunJarName.value
+
+      // copy the assembly jar into the folder that will be zipped eventually
+      IO.copy(
+        Seq((assemblyJar, fatJarFile))
+      )
+      val urls = ClasspathHelper.forManifest(fatJarFile.toURI.toURL).asScala.toList
       val configs = FunctionConfigGenerator.getConfigs(urls)
 
       val baseFolder = azfunTargetFolder.value

plugin/src/sbt-test/sbt-azure-functions/simple/build.sbt

@@ -4,10 +4,8 @@ lazy val root = (project in file("."))
   .settings(
     version := "0.1",
     scalaVersion := "2.12.7",
-    azfunZipName := "myFunctions",
-    azfunJarName := "ScalaFunctions",
-    assemblyOutputPath in assembly := azfunTargetFolder.value / s"${azfunJarName.value}.jar",
     libraryDependencies ++= Seq(
       "com.microsoft.azure.functions" % "azure-functions-java-library" % "1.3.1"
-    )
+    ),
+    assemblyJarName in assembly := "ScalaFunctions.jar"
   )

plugin/src/sbt-test/sbt-azure-functions/simple/test

@@ -3,34 +3,34 @@
 
 # make the Jar
 > assembly
-$ exists target/myFunctions/ScalaFunctions.jar
+$ exists target/scala-2.12/ScalaFunctions.jar
 
 # generate the function.json
 > azfunGenerateFunctionJsons
 # verify that output has been generated
-$ exists target/myFunctions/ScalaFunction/function.json
+$ exists target/AzureFunction/AzureFunction.jar
+$ exists target/AzureFunction/ScalaFunction/function.json
 
 # copy the host.json
 > azfunCopyHostJson
 # verify that the host.json has been copied
-$ exists target/myFunctions/host.json
+$ exists target/AzureFunction/host.json
 
 # copy the local.settings.json
 > azfunCopyLocalSettingsJson
 # verify that the host.json has been copied
-$ exists target/myFunctions/local.settings.json
+$ exists target/AzureFunction/local.settings.json
 
 # reset to test automatic trigger of preceding tasks
 > clean
 
 # zip folder including jar and function json files
 > azfunCreateZipFile
-$ exists target/myFunctions/ScalaFunctions.jar
-$ exists target/myFunctions/host.json
-$ exists target/myFunctions/local.settings.json
-$ exists target/myFunctions/ScalaFunction/function.json
-$ exists target/myFunctions.zip
+$ exists target/AzureFunction/AzureFunction.jar
+$ exists target/AzureFunction/host.json
+$ exists target/AzureFunction/local.settings.json
+$ exists target/AzureFunction/ScalaFunction/function.json
+$ exists target/AzureFunction.zip
 
 # Uncomment the next lines if you want to look at the results from the scripted test
 # $ pause
-

releasenotes.md

@@ -1,5 +1,14 @@
 # Release notes
 
+## Version 0.4.0
+New Features:
+* Instead of in-place packaging of the result from the assembly step, the plugin now copies and renames the assembly jar
+  into another folder (default: `./target/AzureFunction/AzureFunction.jar`) and generates the accompanying files
+  in that same folder.
+  The end result is a zip file (default: `./target/AzureFunction.zip`)
+
+  As a result, there are now no additional settings needed to use the plugin.
+
 ## Version 0.3.1
 Identical to 0.3.0, but releasing is now done to the `code-star/sbt-plugins` repository on Bintray
 (was `code-star/sbt-azure-functions`)

showcase/build.sbt

@@ -2,11 +2,7 @@ lazy val root = (project in file("."))
   .settings(
     name := "showcase",
     version := "1.0",
-    azfunZipName := "myFunctions",
-    azfunJarName := "ScalaFunctions",
-    assemblyOutputPath in assembly := azfunTargetFolder.value / s"${azfunJarName.value}.jar",
     libraryDependencies ++= Seq(
       "com.microsoft.azure.functions" % "azure-functions-java-library" % "1.3.1"
-    ),
-    azfunCreateZipFile := (azfunCreateZipFile dependsOn assembly).value
+    )
   )

version.sbt

@@ -1 +1 @@
-version in ThisBuild := "0.3.2-SNAPSHOT"
+version in ThisBuild := "0.4.1-SNAPSHOT"