refactor: Unicorn Properties v2

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.idea/*
+**/.aws-sam/
+.vscode/*
+.vscode/settings.json

unicorn_contracts/Makefile

@@ -1,34 +1,70 @@
-stackName := uni-prop-local-contract
+#### Global Variables
+stackName		:= $(shell yq -oy '.default.global.parameters.stack_name' samconfig.yaml)
+
+
+#### Test Variables
+apiUrl			= $(call cf_output,$(stackName),ApiUrl)
+ddbPropertyId 	= $(call get_ddb_key,create_contract_valid_payload_1)
+
+
+#### Build/Deploy Tasks
+ci: clean build deploy
 
 build:
+	sam validate --lint
 	cfn-lint template.yaml -a cfn_lint_serverless.rules
 	poetry export --without-hashes --format=requirements.txt --output=src/requirements.txt
 	sam build -c $(DOCKER_OPTS)
 
 deps:
 	poetry install
 
-deploy: build
-	sam deploy --no-confirm-changeset
-
-sync:
-	sam sync --stack-name $(stackName) --watch
+deploy: deps build
+	sam deploy
 
-test: unit-test
+#### Tests
+test: unit-test integration-test
 
 unit-test:
 	poetry run pytest tests/unit/
 
 integration-test: deps
-	AWS_SAM_STACK_NAME=$(stackName) poetry run pytest tests/integration/
+	poetry run pytest tests/integration/
+
+curl-test: clean-tests
+	$(call runif,CREATE CONTRACT)
+	$(call mcurl,POST,create_contract_valid_payload_1)
+
+	$(call runif,Query DDB)
+	$(call ddb_get,$(ddbPropertyId))
+
+	$(call runif,UPDATE CONTRACT)
+	$(call mcurl,PUT,update_existing_contract_valid_payload_1)
+
+	$(call runif,Query DDB)
+	$(call ddb_get,$(ddbPropertyId))
+
+	$(call runif,Delete DDB Items)
+	$(MAKE) clean-tests
+
+	@echo "[DONE]"
+
+
+clean-tests:
+	$(call ddb_delete,$(ddbPropertyId)) || true
+
+
+#### Utilities
+sync:
+	sam sync --stack-name $(stackName) --watch
 
 logs:
-	sam logs --stack-name $(stackName) -t
+	sam logs -t
 
 clean:
 	find . -type d -name __pycache__ -exec rm -rf {} \; 2>/dev/null || true
 	find . -type f -name requirements.txt -exec rm -f {} \; 2>/dev/null || true
-	rm -rf .pytest_cache/ .aws-sam/ htmlcov/ .coverage || true
+	rm -rf .pytest_cache/ .aws-sam/ || true
 
 delete:
 	sam delete --stack-name $(stackName) --no-prompts
@@ -38,3 +74,44 @@ ci_init:
 	poetry export --without-hashes --format=requirements.txt --output=src/requirements.txt --with dev
 	poetry run pip install -r src/requirements.txt
 	poetry install -n
+
+
+#### Helper Functions
+define runif
+	@echo
+	@echo "Run $(1) now?"
+	@read
+	@echo "Running $(1)"
+endef
+
+define ddb_get
+	@aws dynamodb get-item \
+		--table-name $(call cf_output,$(stackName),ContractsTableName) \
+		--key 		'$(1)' \
+	| jq -f tests/integration/transformations/ddb_contract.jq
+endef
+
+define ddb_delete
+	aws dynamodb delete-item \
+		--table-name $(call cf_output,$(stackName),ContractsTableName) \
+		--key 		'$(1)'
+endef
+
+define mcurl
+	curl -X $(1) -H "Content-type: application/json" -d @$(call payload,$(2)) $(apiUrl)contract
+endef
+
+define get_ddb_key
+$(shell jq '. | {property_id:{S:.property_id}}' $(call payload,$(1)) | tr -d ' ')
+endef
+
+define payload
+tests/integration/events/$(1).json
+endef
+
+define cf_output
+	$(shell aws cloudformation describe-stacks \
+		--output text \
+		--stack-name $(1) \
+		--query 'Stacks[0].Outputs[?OutputKey==`$(2)`].OutputValue')
+endef

unicorn_contracts/README.md

@@ -30,3 +30,27 @@ Here is an example of an event that is published to EventBridge:
   }
 }
 ```
+
+### Testing the APIs
+
+```bash
+export API=`aws cloudformation describe-stacks --stack-name uni-prop-local-contract --query "Stacks[0].Outputs[?OutputKey=='ApiUrl'].OutputValue" --output text`
+
+curl --location --request POST "${API}contract" \
+--header 'Content-Type: application/json' \
+--data-raw '{
+"address": {
+"country": "USA",
+"city": "Anytown",
+"street": "Main Street",
+"number": 111
+},
+"seller_name": "John Doe",
+"property_id": "usa/anytown/main-street/111"
+}'
+
+
+curl --location --request PUT "${API}contract" \
+--header 'Content-Type: application/json' \
+--data-raw '{"property_id": "usa/anytown/main-street/111"}' | jq
+```

unicorn_contracts/api.yaml

@@ -0,0 +1,145 @@
+openapi: "3.0.1"
+info:
+  title: "Unicorn Contracts API"
+  version: "1.0.0"
+  description: Unicorn Properties Contract Service API
+paths:
+  /contracts:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateContractModel"
+        required: true
+      responses:
+        "200":
+          description: "200 response"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Empty"
+      x-amazon-apigateway-request-validator: "Validate body"
+      x-amazon-apigateway-integration:
+        credentials:
+          Fn::GetAtt: [UnicornContractsApiIntegrationRole, Arn]
+        httpMethod: "POST"
+        uri:
+          "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:sqs:path/${AWS::AccountId}/${UnicornContractsIngestQueue.QueueName}"
+        responses:
+          default:
+            statusCode: "200"
+            responseTemplates:
+              application/json: '{"message":"OK"}'
+        requestParameters:
+          integration.request.header.Content-Type: "'application/x-www-form-urlencoded'"
+        requestTemplates:
+          application/json: "Action=SendMessage&MessageBody=$input.body&MessageAttribute.1.Name=HttpMethod&MessageAttribute.1.Value.StringValue=$context.httpMethod&MessageAttribute.1.Value.DataType=String"
+        passthroughBehavior: "never"
+        type: "aws"
+    options:
+      responses:
+        "200":
+          description: "200 response"
+          headers:
+            Access-Control-Allow-Origin:
+              schema:
+                type: "string"
+            Access-Control-Allow-Methods:
+              schema:
+                type: "string"
+            Access-Control-Allow-Headers:
+              schema:
+                type: "string"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Empty"
+      x-amazon-apigateway-integration:
+        responses:
+          default:
+            statusCode: "200"
+            responseParameters:
+              method.response.header.Access-Control-Allow-Methods: "'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'"
+              method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'"
+              method.response.header.Access-Control-Allow-Origin: "'*'"
+        requestTemplates:
+          application/json: '{"statusCode": 200}'
+        passthroughBehavior: "when_no_match"
+        type: "mock"
+    put:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateContractModel"
+        required: true
+      responses:
+        "200":
+          description: "200 response"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Empty"
+      x-amazon-apigateway-request-validator: "Validate body"
+      x-amazon-apigateway-integration:
+        credentials:
+          Fn::GetAtt: [UnicornContractsApiIntegrationRole, Arn]
+        httpMethod: "POST"
+        uri:
+          "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:sqs:path/${AWS::AccountId}/${UnicornContractsIngestQueue.QueueName}"
+        responses:
+          default:
+            statusCode: "200"
+            responseTemplates:
+              application/json: '{"message":"OK"}'
+        requestParameters:
+          integration.request.header.Content-Type: "'application/x-www-form-urlencoded'"
+        requestTemplates:
+          application/json: "Action=SendMessage&MessageBody=$input.body&MessageAttribute.1.Name=HttpMethod&MessageAttribute.1.Value.StringValue=$context.httpMethod&MessageAttribute.1.Value.DataType=String"
+        passthroughBehavior: "never"
+        type: "aws"
+components:
+  schemas:
+    CreateContractModel:
+      required:
+        - "property_id"
+        - "seller_name"
+        - "address"
+      type: "object"
+      properties:
+        property_id:
+          type: "string"
+        seller_name:
+          type: "string"
+        address:
+          required:
+            - "city"
+            - "country"
+            - "number"
+            - "street"
+          type: "object"
+          properties:
+            country:
+              type: "string"
+            city:
+              type: "string"
+            street:
+              type: "string"
+            number:
+              type: "integer"
+    UpdateContractModel:
+      required:
+        - "property_id"
+      type: "object"
+      properties:
+        $ref: "#/components/schemas/CreateContractModel/properties"
+        # property_id:
+        #   type: "string"
+    Empty:
+      title: "Empty Schema"
+      type: "object"
+x-amazon-apigateway-request-validators:
+  Validate body:
+    validateRequestParameters: false
+    validateRequestBody: true

unicorn_contracts/integration/ContractStatusChanged.json

@@ -0,0 +1,85 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "ContractStatusChanged"
+  },
+  "paths": {},
+  "components": {
+    "schemas": {
+      "AWSEvent": {
+        "type": "object",
+        "required": [
+          "detail-type",
+          "resources",
+          "detail",
+          "id",
+          "source",
+          "time",
+          "region",
+          "version",
+          "account"
+        ],
+        "x-amazon-events-detail-type": "ContractStatusChanged",
+        "x-amazon-events-source": "unicorn.contracts",
+        "properties": {
+          "detail": {
+            "$ref": "#/components/schemas/ContractStatusChanged"
+          },
+          "account": {
+            "type": "string"
+          },
+          "detail-type": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "region": {
+            "type": "string"
+          },
+          "resources": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            }
+          },
+          "source": {
+            "type": "string"
+          },
+          "time": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "version": {
+            "type": "string"
+          }
+        }
+      },
+      "ContractStatusChanged": {
+        "type": "object",
+        "required": [
+          "contract_last_modified_on",
+          "contract_id",
+          "contract_status",
+          "property_id"
+        ],
+        "properties": {
+          "contract_id": {
+            "type": "string"
+          },
+          "contract_last_modified_on": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "contract_status": {
+            "type": "string"
+          },
+          "property_id": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}