Merge pull request #48 from antmendoza/support-creation-action-object

Support the creation of action  object

Author: tsurdilo

spec/action-builder.spec.ts

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2021-Present The Serverless Workflow Specification Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import {ActionBuilder, ActionDataFilterType, EventRefType} from '../src';
+import {ActionDataFilterBuilder} from '../src/model/action-data-filter.builder';
+
+
+describe("ActionBuilder", () => {
+	
+	it("should throws an error if mandatory fields are not set ", () => {
+		
+		expect(() => new ActionBuilder().build()).toThrowError();
+		
+		expect(() => new ActionBuilder()
+			.withFunctionRef("").build())
+			.toThrowError();
+	});
+	
+	
+	it("should throws an error if both functionRef and eventRef are set", () => {
+		
+		expect(() => new ActionBuilder().build()).toThrowError();
+		
+		expect(() => new ActionBuilder()
+			.withFunctionRef("funcitionRef")
+			.withEventRef(validEventRef()).build())
+			.toThrowError();
+	});
+	
+	it("should generate a populated object", () => {
+		expect(new ActionBuilder()
+			.withName("actionName")
+			.withEventRef(validEventRef())
+			.withTimeOut("PT1H")
+			.withActionDataFilter(new ActionDataFilterBuilder().build())
+			.build()).toEqual(
+			{
+				name: "actionName",
+				eventRef: validEventRef(),
+				timeout: "PT1H",
+				actionDataFilter: validActionDataFilter(),
+			},
+		);
+		
+		
+	});
+	
+	
+});
+
+
+function validActionDataFilter(): ActionDataFilterType {
+	return {};
+}
+
+function validEventRef(): EventRefType {
+	return {resultEventRef: "result"};
+}

src/model/action.builder.ts

@@ -14,22 +14,52 @@
  * limitations under the License.
  *
  */
-import {ActionType, FunctionRefType} from "./types";
+import {ActionDataFilterType, ActionType, EventRefType, FunctionRefType} from "./types";
 
 export class ActionBuilder {
-    // @ts-ignore
-    private model: ActionType = {};
-
-
-    withFunctionRef(value: FunctionRefType): ActionBuilder {
-        this.model.functionRef = value;
-        return this;
-    }
-
-    build(): ActionType {
-        //TODO validate either functionRef or eventRef
-        return this.model;
-    }
-
-
+	
+	private model: ActionType = {};
+	
+	
+	withFunctionRef(value: FunctionRefType): ActionBuilder {
+		this.model.functionRef = value;
+		return this;
+	}
+	
+	withEventRef(value: EventRefType): ActionBuilder {
+		this.model.eventRef = value;
+		return this;
+	}
+	
+	withName(value: string): ActionBuilder {
+		this.model.name = value;
+		return this;
+	}
+	
+	withTimeOut(value: string): ActionBuilder {
+		this.model.timeout = value;
+		return this;
+		
+	}
+	
+	withActionDataFilter(value: ActionDataFilterType): ActionBuilder {
+		this.model.actionDataFilter = value;
+		return this;
+		
+	}
+	
+	build(): ActionType {
+		
+		if (!this.model.eventRef && !this.model.functionRef) {
+			throw new Error("Either eventRef or functionRef have to be defined");
+		}
+		
+		if (this.model.eventRef && this.model.functionRef) {
+			throw new Error("Only one eventRef or functionRef can be set");
+		}
+		
+		
+		return this.model;
+	}
+	
 }

src/model/event-ref.builder.ts

@@ -18,7 +18,6 @@ import {EventRefType} from '../index';
 
 export class EventRefBuilder {
 
-	// @ts-ignore
 	private readonly model: EventRefType = {};
 
 

src/model/types.ts

@@ -52,11 +52,11 @@ export  type EventRefType = {
 	/**
 	 * Reference to the unique name of a 'produced' event definition
 	 */
-	triggerEventRef: string;
+	triggerEventRef?: string;
 	/**
 	 * Reference to the unique name of a 'consumed' event definition
 	 */
-	resultEventRef: string;
+	resultEventRef?: string;
 	/**
 	 * If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'triggerEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'triggerEventRef'.
 	 */
@@ -88,11 +88,15 @@ export type ActionType = {
 	 * Unique action definition name
 	 */
 	name?: string;
-	functionRef: FunctionRefType;
+	
+	/**
+	 * Referenced function
+	 */
+	functionRef?: FunctionRefType;
 	/**
 	 * References a 'trigger' and 'result' reusable event definitions
 	 */
-	eventRef: EventRefType;
+	eventRef?: EventRefType;
 	/**
 	 * Time period to wait for function execution to complete
 	 */