feat(dsl-core): add expect status step

tpluscode · tpluscode · commit 2a0838be70db · 2019-07-11T15:31:23.000+02:00
diff --git a/app.hypermedia.testing.dsl/pom.xml b/app.hypermedia.testing.dsl/pom.xml
@@ -253,5 +253,11 @@
           <version>3.11.1</version>
           <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <version>5.5.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>
diff --git a/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/Core.xtext b/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/Core.xtext
@@ -7,6 +7,11 @@ Model:
 
 TopLevelStep:
 	ClassBlock;
+	
+ResponseStep:
+    StatusStatement |
+    RepresentationStep
+;
 
 RepresentationStep:
     PropertyBlock |
@@ -32,4 +37,8 @@ PropertyStatement:
     EXPECT_MODIFIER 'Property' name=STRING (value=STRING)?
 ;
 
+StatusStatement:
+    EXPECT_MODIFIER 'Status' status=INT
+;
+
 terminal HATCH: '++' -> '++';
diff --git a/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/Hydra.xtext b/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/Hydra.xtext
@@ -33,6 +33,6 @@ OperationBlock:
 
 InvocationBlock:
     {InvocationBlock} 'Invoke' '{'
-        (children+=RepresentationStep)*
+        (children+=ResponseStep)*
     '}'
 ;
diff --git a/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/generator/CoreGenerator.xtend b/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/generator/CoreGenerator.xtend
@@ -14,6 +14,7 @@ import app.hypermedia.testing.dsl.core.PropertyStatement
 import org.apache.commons.lang3.NotImplementedException
 import org.eclipse.emf.ecore.EObject
 import app.hypermedia.testing.dsl.Modifier
+import app.hypermedia.testing.dsl.core.StatusStatement
 
 /**
  * Generates code from your model files on save.
@@ -56,7 +57,7 @@ class CoreGenerator extends AbstractGenerator {
         }
     '''
 
-    def dispatch CharSequence step(PropertyBlock it)  '''
+    def dispatch step(PropertyBlock it)  '''
         {
             "type": "Property",
             "propertyId": "«name»",
@@ -74,7 +75,7 @@ class CoreGenerator extends AbstractGenerator {
         }
     '''
 
-    def dispatch CharSequence step(PropertyStatement it)  '''
+    def dispatch step(PropertyStatement it)  '''
         {
             "type": "Property",
             "propertyId": "«name»",
@@ -85,6 +86,14 @@ class CoreGenerator extends AbstractGenerator {
         }
     '''
 
+    def dispatch step(StatusStatement it)  '''
+        {
+            "type": "Expectation",
+            "expectation": "Status",
+            "code": «status»
+        }
+    '''
+
     def dispatch step(EObject step) {
         throw new NotImplementedException(String.format("Unrecognized step %s", step.class))
     }
diff --git a/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/generator/HydraGenerator.xtend b/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/generator/HydraGenerator.xtend
@@ -48,7 +48,12 @@ class HydraGenerator extends CoreGenerator {
     
     def dispatch step(InvocationBlock it) '''
         {
-            "type": "Invocation"
+            "type": "Invocation",
+            "children": [
+                «FOR child:children SEPARATOR ","»
+                    «child.step»
+                «ENDFOR»
+            ]
         }
     '''
 }
diff --git a/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/validation/CoreValidator.xtend b/app.hypermedia.testing.dsl/src/main/java/app/hypermedia/testing/dsl/validation/CoreValidator.xtend
@@ -3,6 +3,9 @@
  */
 package app.hypermedia.testing.dsl.validation
 
+import app.hypermedia.testing.dsl.core.StatusStatement
+import app.hypermedia.testing.dsl.core.CorePackage
+import org.eclipse.xtext.validation.Check
 
 /**
  * This class contains custom validation rules.
@@ -11,15 +14,12 @@ package app.hypermedia.testing.dsl.validation
  */
 class CoreValidator extends AbstractCoreValidator {
 
-//	public static val INVALID_NAME = 'invalidName'
-//
-//	@Check
-//	def checkGreetingStartsWithCapital(Greeting greeting) {
-//		if (!Character.isUpperCase(greeting.name.charAt(0))) {
-//			warning('Name should start with a capital',
-//					CorePackage.Literals.GREETING__NAME,
-//					INVALID_NAME)
-//		}
-//	}
+    @Check
+    def checkStatusIsWithinRange(StatusStatement statusStatement) {
+        if (statusStatement.status < 100 || statusStatement.status > 599) {
+            error('Status can be an integer between 100 and 599',
+                  CorePackage.Literals.STATUS_STATEMENT__STATUS)
+        }
+    }
 
 }
diff --git a/app.hypermedia.testing.dsl/src/test/java/app/hypermedia/testing/dsl/tests/generator/hydra/OperationTest.snap b/app.hypermedia.testing.dsl/src/test/java/app/hypermedia/testing/dsl/tests/generator/hydra/OperationTest.snap
@@ -49,6 +49,52 @@ app.hypermedia.testing.dsl.tests.generator.hydra.OperationTest.emptyWithOperatio
 ]
 
 
+app.hypermedia.testing.dsl.tests.generator.hydra.OperationTest.topLevelOperationInvocationWithStatusExpectation_generatesSteps=[
+  {
+    "map": {
+      "steps": {
+        "myArrayList": [
+          {
+            "map": {
+              "children": {
+                "myArrayList": [
+                  {
+                    "map": {
+                      "children": {
+                        "myArrayList": [
+                          {
+                            "map": {
+                              "code": 201,
+                              "expectation": "Status",
+                              "type": "Expectation"
+                            },
+                            "empty": false
+                          }
+                        ],
+                        "empty": false
+                      },
+                      "type": "Invocation"
+                    },
+                    "empty": false
+                  }
+                ],
+                "empty": false
+              },
+              "operationId": "CreateUser",
+              "strict": false,
+              "type": "Operation"
+            },
+            "empty": false
+          }
+        ],
+        "empty": false
+      }
+    },
+    "empty": false
+  }
+]
+
+
 app.hypermedia.testing.dsl.tests.generator.hydra.OperationTest.topLevelOperationMultipleInvocations_generatesStep=[
   {
     "map": {
@@ -60,18 +106,30 @@ app.hypermedia.testing.dsl.tests.generator.hydra.OperationTest.topLevelOperation
                 "myArrayList": [
                   {
                     "map": {
+                      "children": {
+                        "myArrayList": [ ],
+                        "empty": true
+                      },
                       "type": "Invocation"
                     },
                     "empty": false
                   },
                   {
                     "map": {
+                      "children": {
+                        "myArrayList": [ ],
+                        "empty": true
+                      },
                       "type": "Invocation"
                     },
                     "empty": false
                   },
                   {
                     "map": {
+                      "children": {
+                        "myArrayList": [ ],
+                        "empty": true
+                      },
                       "type": "Invocation"
                     },
                     "empty": false
diff --git a/app.hypermedia.testing.dsl/src/test/java/app/hypermedia/testing/dsl/tests/generator/hydra/OperationTest.xtend b/app.hypermedia.testing.dsl/src/test/java/app/hypermedia/testing/dsl/tests/generator/hydra/OperationTest.xtend
@@ -76,4 +76,25 @@ class OperationTest {
         val file = new JSONObject(fsa.textFiles.values.get(0).toString)
         expect(file).toMatchSnapshot()
     }
+
+    @Test
+    def topLevelOperationInvocationWithStatusExpectation_generatesSteps() {
+        // given
+        val model = parseHelper.parse('''
+            With Operation "CreateUser" {
+                Invoke {
+                    Expect Status 201
+                }
+            }
+        ''')
+        
+        // when
+        val fsa = new InMemoryFileSystemAccess()
+        generator.doGenerate(model.eResource, fsa, new GeneratorContext())
+        println(fsa.textFiles)
+
+        // then
+        val file = new JSONObject(fsa.textFiles.values.get(0).toString)
+        expect(file).toMatchSnapshot()
+    }
 }
diff --git a/app.hypermedia.testing.dsl/src/test/java/app/hypermedia/testing/dsl/tests/hydra/StatusParsingTest.xtend b/app.hypermedia.testing.dsl/src/test/java/app/hypermedia/testing/dsl/tests/hydra/StatusParsingTest.xtend
@@ -0,0 +1,86 @@
+/*
+ * generated by Xtext 2.18.0
+ */
+package app.hypermedia.testing.dsl.tests.hydra
+
+import app.hypermedia.testing.dsl.core.Model
+import com.google.inject.Inject
+import org.eclipse.xtext.testing.InjectWith
+import org.eclipse.xtext.testing.extensions.InjectionExtension
+import org.eclipse.xtext.testing.util.ParseHelper
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.^extension.ExtendWith
+import static org.junit.Assert.assertEquals
+import app.hypermedia.testing.dsl.tests.HydraInjectorProvider
+import app.hypermedia.testing.dsl.tests.TestHelpers
+import app.hypermedia.testing.dsl.hydra.RelaxedOperationBlock
+import app.hypermedia.testing.dsl.core.StatusStatement
+import org.junit.jupiter.params.provider.MethodSource
+import org.junit.jupiter.params.ParameterizedTest
+import app.hypermedia.testing.dsl.hydra.InvocationBlock
+import app.hypermedia.testing.dsl.core.CorePackage
+import org.eclipse.xtext.testing.validation.ValidationTestHelper
+
+@ExtendWith(InjectionExtension)
+@InjectWith(HydraInjectorProvider)
+class StatusParsingTest {
+    @Inject extension ParseHelper<Model>
+    @Inject extension ValidationTestHelper
+
+    @ParameterizedTest
+    @MethodSource("validStatuses")
+    def void expectStatus_parsesSuccessfullyUnderInvoke(int status) {
+        // when
+        val result = '''
+            With Operation "CreateUser" {
+                Invoke {
+                    Expect Status «status»
+                }
+            }
+        '''.parse
+
+        // then
+        TestHelpers.assertModelParsedSuccessfully(result)
+        
+        val operationBlock = result.steps.get(0) as RelaxedOperationBlock
+        val invocationBlock = operationBlock.invocations.get(0) as InvocationBlock
+        val statusBlock = invocationBlock.children.get(0) as StatusStatement
+        assertEquals(statusBlock.status, status)
+    }
+
+    @ParameterizedTest
+    @MethodSource("invalidStatuses")
+    def void expectStatus_failsToParseBogusStatus(int status) {
+        // when
+        val result = '''
+            With Operation "CreateUser" {
+                Invoke {
+                    Expect Status «status»
+                }
+            }
+        '''.parse
+
+        // then
+        result.assertError(
+            CorePackage.Literals.STATUS_STATEMENT,
+            null,
+            "Status can be an integer between 100 and 599"
+        )
+    }
+    
+    static def invalidStatuses() {
+        return #[
+            1000,
+            600,
+            -10,
+            0,
+            99
+        ]
+    } 
+    
+    static def validStatuses() {
+        return #[
+            100, 201, 404, 599
+        ]
+    } 
+}

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,6 @@ OperationBlock:`
`33`	`33`
`34`	`34`	`InvocationBlock:`
`35`	`35`	`{InvocationBlock} 'Invoke' '{'`
`36`		`- (children+=RepresentationStep)*`
	`36`	`+ (children+=ResponseStep)*`
`37`	`37`	`'}'`
`38`	`38`	`;`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ import app.hypermedia.testing.dsl.core.PropertyStatement`
`14`	`14`	`import org.apache.commons.lang3.NotImplementedException`
`15`	`15`	`import org.eclipse.emf.ecore.EObject`
`16`	`16`	`import app.hypermedia.testing.dsl.Modifier`
	`17`	`+import app.hypermedia.testing.dsl.core.StatusStatement`
`17`	`18`
`18`	`19`	`/**`
`19`	`20`	`* Generates code from your model files on save.`
`@@ -56,7 +57,7 @@ class CoreGenerator extends AbstractGenerator {`
`56`	`57`	`}`
`57`	`58`	`'''`
`58`	`59`
`59`		`- def dispatch CharSequence step(PropertyBlock it) '''`
	`60`	`+ def dispatch step(PropertyBlock it) '''`
`60`	`61`	`{`
`61`	`62`	`"type": "Property",`
`62`	`63`	`"propertyId": "«name»",`
`@@ -74,7 +75,7 @@ class CoreGenerator extends AbstractGenerator {`
`74`	`75`	`}`
`75`	`76`	`'''`
`76`	`77`
`77`		`- def dispatch CharSequence step(PropertyStatement it) '''`
	`78`	`+ def dispatch step(PropertyStatement it) '''`
`78`	`79`	`{`
`79`	`80`	`"type": "Property",`
`80`	`81`	`"propertyId": "«name»",`
`@@ -85,6 +86,14 @@ class CoreGenerator extends AbstractGenerator {`
`85`	`86`	`}`
`86`	`87`	`'''`
`87`	`88`
	`89`	`+ def dispatch step(StatusStatement it) '''`
	`90`	`+ {`
	`91`	`+ "type": "Expectation",`
	`92`	`+ "expectation": "Status",`
	`93`	`+ "code": «status»`
	`94`	`+ }`
	`95`	`+ '''`
	`96`	`+`
`88`	`97`	`def dispatch step(EObject step) {`
`89`	`98`	`throw new NotImplementedException(String.format("Unrecognized step %s", step.class))`
`90`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,12 @@ class HydraGenerator extends CoreGenerator {`
`48`	`48`
`49`	`49`	`def dispatch step(InvocationBlock it) '''`
`50`	`50`	`{`
`51`		`- "type": "Invocation"`
	`51`	`+ "type": "Invocation",`
	`52`	`+ "children": [`
	`53`	`+ «FOR child:children SEPARATOR ","»`
	`54`	`+ «child.step»`
	`55`	`+ «ENDFOR»`
	`56`	`+ ]`
`52`	`57`	`}`
`53`	`58`	`'''`
`54`	`59`	`}`