Publish json-schema (#867)

* Adds java-language-server;

* Re-structure layout of file-names;

* Adapt references to schema-files;

* Fixes;

* Fix missing cleanup-command;

* Add script to flatten schemas;

* Update development-environment;

* Remove unnecessary file;

* Add the binding-request-schema as an output;

* 🔧 Fix issue with double `/` in file-path;

* 🚧 Work in progress: Debugging;

* Unset focus;

Author: joergdw

.editorconfig

@@ -9,23 +9,24 @@ trim_trailing_whitespace = true
 indent_style = space
 indent_size = 2
 
+[{*.bash,*.sh}]
+indent_style = tab
+indent_size = 2
+softtabstop = 2
+
+[Dockerfile]
+indent_size = 4
+indent_style = tab
+
 [{Makefile,go.mod,go.sum,*.go,.gitmodules}]
 indent_style = tab
 indent_size = 4
 
 [*.md]
 indent_size = 4
 trim_trailing_whitespace = false
-
 eclint_indent_style = unset
 
-[Dockerfile]
+[*.py]
 indent_size = 4
-indent_style = tab
-
-[{*.bash,*.sh}]
-indent_style = tab
-indent_size = 2
-softtabstop = 2
-
-
+indent_style = space

Makefile

@@ -5,6 +5,7 @@ aes_terminal_font_yellow := \033[38;2;255;255;0m
 aes_terminal_reset := \033[0m
 VERSION ?= 0.0.0-rc.1
 DEST ?= /tmp/build
+TARGET_DIR ?= ./build
 MTAR_FILENAME ?= app-autoscaler-release-v$(VERSION).mtar
 ACCEPTANCE_TESTS_FILE ?= ${DEST}/app-autoscaler-acceptance-tests-v$(VERSION).tgz
 CI ?= false
@@ -199,7 +200,7 @@ ${gorouter-proxy.program}: ./go.mod ./go.sum ${gorouter-proxy.source}
 .PHONY: integration
 integration: generate-fakes init-db test-certs build_all build-gorouterproxy
 	@echo "# Running integration tests"
-	APP_AUTOSCALER_TEST_RUN='true' DBURL='${DBURL}' go run github.com/onsi/ginkgo/v2/ginkgo ${GINKGO_OPTS} integration DBURL="${DBURL}"
+	APP_AUTOSCALER_TEST_RUN='true' DBURL='${DBURL}' ginkgo ${GINKGO_OPTS} integration DBURL="${DBURL}"
 
 .PHONY: init-db
 init-db: check-db_type start-db db.java-libs target/init-db-${db_type}
@@ -249,6 +250,7 @@ clean: dbtasks.clean scheduler.clean
 	@rm --force --recursive "${openapi-generated-clients-and-servers-api-dir}"
 	@rm --force --recursive "${openapi-generated-clients-and-servers-scalingengine-dir}"
 	@go clean -cache -testcache
+	@rm --force --recursive 'build'
 	@rm --force --recursive 'fakes'
 	@rm --force --recursive 'test-certs'
 	@rm --force --recursive 'target'
@@ -260,6 +262,16 @@ dbtasks.clean:
 scheduler.clean:
 	pushd scheduler; mvn clean; popd
 
+schema-files := $(shell find ./api/policyvalidator -type f -name '*.json')
+flattened-schema-file := ${TARGET_DIR}/bind-request.schema.json
+BIND_REQ_SCHEMA_VERSION ?= v0.1
+bind-request-schema: ${flattened-schema-file}
+${flattened-schema-file}: ${schema-files}
+	mkdir -p "$$(dirname ${flattened-schema-file})"
+	flatten_json-schema './api/policyvalidator/json-schema/${BIND_REQ_SCHEMA_VERSION}/meta.schema.json' \
+	> '${flattened-schema-file}'
+	echo '🔨 File created: ${flattened-schema-file}'
+
 mta-deploy: mta-build build-extension-file
 	$(MAKE) -f metricsforwarder/Makefile set-security-group
 	@echo "Deploying with extension file: $(EXTENSION_FILE)"
@@ -301,7 +313,7 @@ release-draft: ## Create a draft GitHub release without artifacts
 		./scripts/release.sh
 
 .PHONY: create-assets
-create-assets: ## Create release assets (mtar and acceptance tests)
+create-assets: ## Create release assets (mtar and acceptance tests), please provide `VERSION` as environment-variable.
 		./scripts/create-assets.sh
 
 .PHONY: release-promote

acceptance/broker/broker_test.go

@@ -272,14 +272,12 @@ var _ = Describe("AutoScaler Service Broker", func() {
 
 				It("fails", func() {
 					// Preparation
-					paramsTemplate := `
-{
-  "schema-version": "0.1",
-  "configuration": {
-	"app_guid": "%s"
-  }
-}
-`
+					paramsTemplate := `{
+						"schema-version": "0.1",
+						"configuration": {
+						  "app_guid": "%s"
+						}
+					  }`
 					params := fmt.Sprintf(paramsTemplate, appGuid)
 
 					// Execution

api/broker/broker_suite_test.go

@@ -50,7 +50,7 @@ var _ = BeforeSuite(func() {
 	conf = &config.Config{
 		CatalogPath:                        "../exampleconfig/catalog-example.json",
 		DashboardRedirectURI:               dashBoardURL,
-		PolicySchemaPath:                   "../policyvalidator/meta.schema.json",
+		PolicySchemaPath:                   "../policyvalidator/json-schema/meta.schema.json",
 		DefaultCustomMetricsCredentialType: "binding-secret",
 	}
 

api/brokerserver/broker_handler_test.go

@@ -1186,7 +1186,10 @@ var _ = Describe("BrokerHandler", func() {
 				It("fails with 400", func() {
 					Expect(resp.Code).To(Equal(http.StatusBadRequest))
 					Expect(resp.Body.String()).To(MatchJSON(
-						`{"error": "InvalidPolicy", "description": "invalid policy provided: [{\"context\":\"(root)\",\"description\":\"Must validate one and only one schema (oneOf)\"},{\"context\":\"(root).credential-type\",\"description\":\"credential-type must be one of the following: \\\"x509\\\", \\\"binding-secret\\\"\"}]"}`,
+						`{
+						  "error": "InvalidPolicy",
+						  "description": "invalid policy provided: [{\"context\":\"(root)\",\"description\":\"Must validate one and only one schema (oneOf)\"},{\"context\":\"(root)\",\"description\":\"Must validate one and only one schema (oneOf)\"},{\"context\":\"(root)\",\"description\":\"schema-version is required\"},{\"context\":\"(root).credential-type\",\"description\":\"credential-type must be one of the following: \\\"x509\\\", \\\"binding-secret\\\"\"}]"
+						}`,
 					))
 				})
 

api/brokerserver/broker_server_suite_test.go

@@ -129,7 +129,7 @@ var _ = BeforeSuite(func() {
 		},
 		CatalogPath:       "../exampleconfig/catalog-example.json",
 		CatalogSchemaPath: "../schemas/catalog.schema.json",
-		PolicySchemaPath:  "../policyvalidator/meta.schema.json",
+		PolicySchemaPath:  "../policyvalidator/json-schema/meta.schema.json",
 		Scheduler: config.SchedulerConfig{
 			SchedulerURL: schedulerServer.URL(),
 		},

api/cmd/api/api_suite_test.go

@@ -164,7 +164,7 @@ var _ = SynchronizedBeforeSuite(func() []byte {
 
 	conf.CatalogPath = "../../exampleconfig/catalog-example.json"
 	conf.CatalogSchemaPath = "../../schemas/catalog.schema.json"
-	conf.PolicySchemaPath = "../policyvalidator/meta.schema.json"
+	conf.PolicySchemaPath = "../policyvalidator/json-schema/meta.schema.json"
 
 	schedulerServer = ghttp.NewServer()
 	conf.Scheduler.SchedulerURL = schedulerServer.URL()

api/default_config.json

@@ -9,7 +9,7 @@
     },
     "catalog_schema_path": "/home/vcap/app/api/schemas/catalog.schema.json",
     "info_file_path": "/home/vcap/app/api/default_info.json",
-    "policy_schema_path": "/home/vcap/app/api/policyvalidator/meta.schema.json",
+    "policy_schema_path": "/home/vcap/app/api/policyvalidator/json-schema/meta.schema.json",
     "dashboard_redirect_uri": null,
     "default_credential_type": "binding-secret",
     "health": {

api/policyvalidator/legacy.schema.json …validator/json-schema/legacy.schema.jsonapi/policyvalidator/legacy.schema.json renamed to api/policyvalidator/json-schema/legacy.schema.json api/policyvalidator/legacy.schema.json renamed to api/policyvalidator/json-schema/legacy.schema.json

@@ -4,8 +4,7 @@
   "description": "Unification of different schemas for scaling-policies for Autoscaler",
 
   "oneOf": [
-    {"$ref": "./scaling-policy.v0_1.schema.json"},
-    {"$ref": "./legacy.schema.json"},
-    {"$ref": "./service-key_only.v0_1.schema.json"}
+    {"$ref": "./v0.1/meta.schema.json"},
+    {"$ref": "./legacy.schema.json"}
   ]
 }