chore: Consolidate tasks (#99)

* Update the root Makefile to run for each library
* Add format and codegen targets to root Makefile
* Add java and net format/check targets
* Update format action to prepare for update

.github/workflows/library_dafny_format.yml → .github/workflows/library_format.yml

@@ -1,5 +1,5 @@
 # This workflow performs static analysis checks.
-name: Library Dafny format check
+name: Library format check
 
 on:
   workflow_call:
@@ -49,4 +49,21 @@ jobs:
         run: |
           # This works because `node` is installed by default on GHA runners
           CORES=$(node -e 'console.log(os.cpus().length)')
-          make format-check
+          make format_dafny-check
+
+      # Commented out until the format has been updated
+      # - name: Check format of ${{ matrix.library }} Net code
+      #   shell: bash
+      #   working-directory: ./${{ matrix.library }}
+      #   run: |
+      #     # This works because `node` is installed by default on GHA runners
+      #     CORES=$(node -e 'console.log(os.cpus().length)')
+      #     make format_net-check
+
+      # - name: Check format of ${{ matrix.library }} Java code
+      #   shell: bash
+      #   working-directory: ./${{ matrix.library }}
+      #   run: |
+      #     # This works because `node` is installed by default on GHA runners
+      #     CORES=$(node -e 'console.log(os.cpus().length)')
+      #     make format_java-check

.github/workflows/manual.yml

@@ -13,7 +13,7 @@ on:
 
 jobs:
   manual-ci-format:
-    uses: ./.github/workflows/library_dafny_format.yml
+    uses: ./.github/workflows/library_format.yml
     with:
       dafny: '4.2.0'
   manual-ci-verification:

.github/workflows/pull.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   pr-ci-format:
-    uses: ./.github/workflows/library_dafny_format.yml
+    uses: ./.github/workflows/library_format.yml
     with:
       dafny: '4.2.0'
   pr-ci-verification:

.github/workflows/push.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   push-ci-format:
-    uses: ./.github/workflows/library_dafny_format.yml
+    uses: ./.github/workflows/library_format.yml
     with:
       dafny: '4.2.0'
   push-ci-verification:

AwsCryptographicMaterialProviders/Makefile

@@ -44,5 +44,3 @@ SERVICE_DEPS_AwsCryptographyKeyStore := \
 	ComAmazonawsDynamodb \
 	AwsCryptographicMaterialProviders/dafny/AwsCryptographicMaterialProviders \
 
-format_net:
-	pushd runtimes/net && dotnet format && popd

AwsCryptographicMaterialProviders/runtimes/java/build.gradle.kts

@@ -7,6 +7,9 @@ plugins {
     `signing`
     id("com.github.johnrengelman.shadow") version "7.1.2"
     id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
+    if (JavaVersion.current() >= JavaVersion.VERSION_11) {
+      id("com.diffplug.spotless") version "6.22.0"
+    }
 }
 
 group = "software.amazon.cryptography"
@@ -307,3 +310,10 @@ fun buildPom(mavenPublication: MavenPublication) {
         }
     }
 }
+
+// Commented out until the format has been updated
+// spotless {
+//   java {
+//     googleJavaFormat()
+//   }
+// }

AwsCryptographyPrimitives/runtimes/java/build.gradle.kts

@@ -4,6 +4,9 @@ import javax.annotation.Nullable
 plugins {
     `java-library`
     `maven-publish`
+    if (JavaVersion.current() >= JavaVersion.VERSION_11) {
+        id("com.diffplug.spotless") version "6.22.0"
+    }
 }
 
 group = "software.amazon.cryptography"
@@ -82,3 +85,10 @@ tasks {
         classpath = sourceSets["test"].runtimeClasspath
     }
 }
+
+// Commented out until the format has been updated
+// spotless {
+//   java {
+//     googleJavaFormat()
+//   }
+// }

ComAmazonawsDynamodb/runtimes/java/build.gradle.kts

@@ -4,6 +4,9 @@ import javax.annotation.Nullable
 plugins {
     `java-library`
     `maven-publish`
+    if (JavaVersion.current() >= JavaVersion.VERSION_11) {
+        id("com.diffplug.spotless") version "6.22.0"
+    }
 }
 
 group = "software.amazon.cryptography"
@@ -87,3 +90,10 @@ tasks {
         classpath = sourceSets["test"].runtimeClasspath
     }
 }
+
+// Commented out until the format has been updated
+// spotless {
+//   java {
+//     googleJavaFormat()
+//   }
+// }

ComAmazonawsKms/runtimes/java/build.gradle.kts

@@ -4,6 +4,9 @@ import javax.annotation.Nullable
 plugins {
     `java-library`
     `maven-publish`
+    if (JavaVersion.current() >= JavaVersion.VERSION_11) {
+        id("com.diffplug.spotless") version "6.22.0"
+    }
 }
 
 group = "software.amazon.cryptography"
@@ -87,3 +90,10 @@ tasks {
         classpath = sourceSets["test"].runtimeClasspath
     }
 }
+
+// Commented out until the format has been updated
+// spotless {
+//   java {
+//     googleJavaFormat()
+//   }
+// }

Makefile

@@ -1,21 +1,44 @@
 # Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# This finds all Dafny projects in this repository
+# This makes building root level targets for each project easy
+PROJECTS = $(shell  find . -mindepth 2 -maxdepth 2 -type f -name "Makefile" | xargs dirname | xargs basename)
+
 verify:
-	$(MAKE) -C StandardLibrary verify CORES=4
-	$(MAKE) -C AwsCryptographyPrimitives verify CORES=4
-	$(MAKE) -C ComAmazonawsKms verify CORES=4
-	$(MAKE) -C ComAmazonawsDynamodb verify CORES=4
-	$(MAKE) -C AwsCryptographicMaterialProviders verify CORES=4
-	$(MAKE) -C TestVectorsAwsCryptographicMaterialProviders verify CORES=4
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) verify CORES=4 && \
+	) true
 
 dafny-reportgenerator:
-	$(MAKE) -C StandardLibrary dafny-reportgenerator
-	$(MAKE) -C AwsCryptographyPrimitives dafny-reportgenerator
-	$(MAKE) -C ComAmazonawsKms dafny-reportgenerator
-	$(MAKE) -C ComAmazonawsDynamodb dafny-reportgenerator
-	$(MAKE) -C AwsCryptographicMaterialProviders dafny-reportgenerator
-	$(MAKE) -C TestVectorsAwsCryptographicMaterialProviders dafny-reportgenerator
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) dafny-reportgenerator && \
+	) true
+
+clean-dafny-report:
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) clean-dafny-report && \
+	) true
+
+format_dafny:
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) format_dafny && \
+	) true
+
+format_net:
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) format_net && \
+	) true
+
+format_java:
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) format_java && \
+	) true
+
+polymorph_code_gen:
+	$(foreach PROJECT, $(PROJECTS), \
+		$(MAKE) -C $(PROJECT) polymorph_code_gen && \
+	) true
 
 duvet: | duvet_extract duvet_report
 
@@ -35,12 +58,3 @@ duvet_report:
 		--source-pattern "AwsCryptographicMaterialProviders/compliance_exceptions/**/*.txt" \
 		--source-pattern "(# //=,# //#).github/workflows/duvet.yaml" \
 		--html specification_compliance_report.html
-
-format:
-	$(MAKE) -C StandardLibrary format
-	$(MAKE) -C AwsCryptographyPrimitives format
-	$(MAKE) -C ComAmazonawsKms format
-	$(MAKE) -C ComAmazonawsDynamodb format
-	$(MAKE) -C AwsCryptographicMaterialProviders format
-	$(MAKE) -C TestVectorsAwsCryptographicMaterialProviders format
-

SharedMakefileV2.mk

@@ -123,14 +123,14 @@ verify_service:
 		-trace \
 		`find ./dafny/$(SERVICE) -name '*.dfy'` \
 
-format:
+format_dafny:
 	dafny format \
 		--function-syntax 3 \
 		--quantifier-syntax 3 \
 		--unicode-char false \
 		`find . -name '*.dfy'`
 
-format-check:
+format_dafny-check:
 	dafny format \
 		--check \
 		--function-syntax 3 \
@@ -144,6 +144,9 @@ dafny-reportgenerator:
 		--max-resource-count $(MAX_RESOURCE_COUNT) \
 		TestResults/*.csv
 
+clean-dafny-report:
+	rm TestResults/*.csv
+
 # Dafny helper targets
 
 # Transpile the entire project's impl
@@ -341,11 +344,23 @@ test_net_mac_brew:
 setup_net:
 	dotnet restore runtimes/net/
 
+format_net:
+	dotnet format runtimes/net/*.csproj
+
+format_net-check:
+	dotnet format runtimes/net/*.csproj --verify-no-changes
+
 ########################## Java targets
 
 build_java: transpile_java mvn_local_deploy_dependencies
 	./runtimes/java/gradlew -p runtimes/java build
 
+format_java:
+	./runtimes/java/gradlew -p runtimes/java spotlessApply
+
+format_java-check:
+	./runtimes/java/gradlew -p runtimes/java spotlessCheck
+
 transpile_java: | transpile_implementation_java transpile_test_java transpile_dependencies_java
 
 transpile_implementation_java: TARGET=java

StandardLibrary/runtimes/java/build.gradle.kts

@@ -4,6 +4,9 @@ import javax.annotation.Nullable
 plugins {
     `java-library`
     `maven-publish`
+    if (JavaVersion.current() >= JavaVersion.VERSION_11) {
+      id("com.diffplug.spotless") version "6.22.0"
+    }
 }
 
 group = "software.amazon.cryptography"
@@ -78,3 +81,10 @@ tasks {
         classpath = sourceSets["test"].runtimeClasspath
     }
 }
+
+// Commented out until the format has been updated
+// spotless {
+//   java {
+//     googleJavaFormat()
+//   }
+// }

TestVectorsAwsCryptographicMaterialProviders/Makefile

@@ -55,6 +55,3 @@ SERVICE_DEPS_KeyVectors := \
 	ComAmazonawsDynamodb \
 	AwsCryptographicMaterialProviders/dafny/AwsCryptographyKeyStore \
 	AwsCryptographicMaterialProviders/dafny/AwsCryptographicMaterialProviders \
-
-format_net:
-	pushd runtimes/net && dotnet format && popd

TestVectorsAwsCryptographicMaterialProviders/runtimes/java/build.gradle.kts

@@ -8,6 +8,9 @@ tasks.wrapper {
 plugins {
     `java-library`
     `maven-publish`
+    if (JavaVersion.current() >= JavaVersion.VERSION_11) {
+        id("com.diffplug.spotless") version "6.22.0"
+    }
 }
 
 group = "software.amazon.cryptography"
@@ -94,3 +97,10 @@ tasks.register<Copy>("copyKeysJSON") {
     from(layout.projectDirectory.file("../../dafny/TestVectorsAwsCryptographicMaterialProviders/test/keys.json"))
     into(layout.projectDirectory.dir("dafny/TestVectorsAwsCryptographicMaterialProviders/test"))
 }
+
+// Commented out until the format has been updated
+// spotless {
+//   java {
+//     googleJavaFormat()
+//   }
+// }