Rebranding (#287)

samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy

@@ -0,0 +1,30 @@
+/*
+ *  Copyright 2013-2016 the original author or authors.
+ *
+ *  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
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  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.
+ */
+
+package org.springframework.cloud.contract.verifier.samples.messaging
+
+import com.fasterxml.jackson.annotation.JsonCreator
+import groovy.transform.CompileStatic
+
+@CompileStatic
+class BookDeleted {
+	final String bookName
+
+	@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
+	BookDeleted(String bookName) {
+		this.bookName = bookName
+	}
+}

samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy

@@ -0,0 +1,54 @@
+/*
+ *  Copyright 2013-2016 the original author or authors.
+ *
+ *  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
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  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.
+ */
+
+package org.springframework.cloud.contract.verifier.samples.messaging
+
+import groovy.transform.CompileStatic
+import groovy.util.logging.Slf4j
+import org.springframework.messaging.Message
+import org.springframework.messaging.MessageHeaders
+import org.springframework.messaging.support.MessageBuilder
+
+import java.util.concurrent.atomic.AtomicBoolean
+
+@CompileStatic
+@Slf4j
+class BookListener {
+
+	/**
+	   Scenario for "should generate tests triggered by a message":
+	     client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom
+	     server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom
+	 */
+	Message returnBook(BookReturned bookReturned) {
+		log.info("Returning book [$bookReturned]")
+		return MessageBuilder.createMessage(bookReturned, new MessageHeaders([
+		        'BOOK-NAME': bookReturned.bookName as Object
+		]))
+	}
+
+	/**
+	   Scenario for "should generate tests triggered by a message":
+	     client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom
+	     server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom
+	 */
+	void bookDeleted(BookDeleted bookDeleted) {
+		log.info("Deleting book [$bookDeleted]")
+		bookSuccessfulyDeleted.set(true)
+	}
+
+	AtomicBoolean bookSuccessfulyDeleted = new AtomicBoolean(false)
+}

samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy

@@ -0,0 +1,30 @@
+/*
+ *  Copyright 2013-2016 the original author or authors.
+ *
+ *  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
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  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.
+ */
+
+package org.springframework.cloud.contract.verifier.samples.messaging
+
+import com.fasterxml.jackson.annotation.JsonCreator
+import groovy.transform.CompileStatic
+
+@CompileStatic
+class BookReturned {
+	final String bookName
+
+	@JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
+	BookReturned(String bookName) {
+		this.bookName = bookName
+	}
+}

samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy

@@ -0,0 +1,48 @@
+/*
+ *  Copyright 2013-2016 the original author or authors.
+ *
+ *  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
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  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.
+ */
+
+package org.springframework.cloud.contract.verifier.samples.messaging
+
+import groovy.transform.CompileStatic
+import groovy.util.logging.Slf4j
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.beans.factory.annotation.Qualifier
+import org.springframework.messaging.MessageChannel
+import org.springframework.messaging.MessageHeaders
+import org.springframework.messaging.support.MessageBuilder
+import org.springframework.stereotype.Service
+
+@Service
+@CompileStatic
+@Slf4j
+class BookService {
+
+	@Autowired @Qualifier("outputChannel") MessageChannel outputChannel
+
+	/**
+	   Scenario for "should generate tests triggered by a method":
+	      client side: must have a possibility to "trigger" sending of a message to the given messageFrom
+	      server side: will run the method and await upon receiving message on the output messageFrom
+
+	   Method triggers sending a message to a source
+	 */
+	void returnBook(BookReturned bookReturned) {
+		log.info("Returning book [$bookReturned]")
+		outputChannel.send(MessageBuilder.createMessage(bookReturned, new MessageHeaders([
+		        'BOOK-NAME': bookReturned.bookName as Object
+		])))
+	}
+}

samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplication.groovy

@@ -0,0 +1,30 @@
+/*
+ *  Copyright 2013-2016 the original author or authors.
+ *
+ *  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
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  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.
+ */
+
+package org.springframework.cloud.contract.verifier.samples.messaging
+
+import org.springframework.boot.SpringApplication
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.context.annotation.ImportResource
+
+@SpringBootApplication
+@ImportResource("classpath*:integration-context.xml")
+class IntegrationMessagingApplication {
+
+	static void main(String[] args) {
+		SpringApplication.run(IntegrationMessagingApplication.class, args)
+	}
+}

samples/samples-messaging-integration/src/main/resources/integration-context.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~  Copyright 2013-2016 the original author or authors.
+  ~
+  ~  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
+  ~
+  ~       http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~  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.
+  -->
+
+<beans:beans xmlns="http://www.springframework.org/schema/integration"
+			 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+			 xmlns:beans="http://www.springframework.org/schema/beans"
+			 xsi:schemaLocation="http://www.springframework.org/schema/beans
+			http://www.springframework.org/schema/beans/spring-beans.xsd
+			http://www.springframework.org/schema/integration
+			http://www.springframework.org/schema/integration/spring-integration.xsd">
+
+	<channel id="input"/>
+	<channel id="delete"/>
+	<channel id="outputChannel"/>
+
+	<service-activator input-channel="inputChannel"
+					   output-channel="outputChannel"
+					   ref="bookListener"
+					   method="returnBook"/>
+
+	<json-to-object-transformer input-channel="input" type="org.springframework.cloud.contract.verifier.samples.messaging.BookReturned"
+	output-channel="inputChannel"/>
+
+	<service-activator input-channel="deleteChannel"
+					   ref="bookListener"
+					   method="bookDeleted"/>
+
+	<json-to-object-transformer input-channel="delete" type="org.springframework.cloud.contract.verifier.samples.messaging.BookDeleted"
+								output-channel="deleteChannel"/>
+
+	<beans:bean id="bookListener" class="org.springframework.cloud.contract.verifier.samples.messaging.BookListener"/>
+
+
+	<!-- REQUIRED FOR TESTING -->
+	<bridge input-channel="outputChannel"
+			output-channel="output"/>
+
+	<channel id="output">
+		<queue/>
+	</channel>
+
+</beans:beans>

samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy

@@ -0,0 +1,168 @@
+/*
+ *  Copyright 2013-2016 the original author or authors.
+ *
+ *  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
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  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.
+ */
+
+package org.springframework.cloud.contract.verifier.samples.messaging
+
+import com.jayway.jsonpath.DocumentContext
+import com.jayway.jsonpath.JsonPath
+import com.toomuchcoding.jsonassert.JsonAssertion
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.SpringApplicationContextLoader
+import org.springframework.cloud.contract.verifier.dsl.Contract
+import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage
+import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging
+import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper
+import org.springframework.test.context.ContextConfiguration
+import spock.lang.Specification
+
+import javax.inject.Inject
+// Context configuration would end up in base class
+@ContextConfiguration(classes = [IntegrationMessagingApplication], loader = SpringApplicationContextLoader)
+public class IntegrationMessagingApplicationSpec extends Specification {
+
+	// ALL CASES
+	@Inject ContractVerifierMessaging contractVerifierMessaging
+	ContractVerifierObjectMapper contractVerifierObjectMapper = new ContractVerifierObjectMapper()
+
+	def "should work for triggered based messaging"() {
+		given:
+		// tag::method_trigger[]
+			def dsl = Contract.make {
+				// Human readable description
+				description 'Some description'
+				// Label by means of which the output message can be triggered
+				label 'some_label'
+				// input to the contract
+				input {
+					// the contract will be triggered by a method
+					triggeredBy('bookReturnedTriggered()')
+				}
+				// output message of the contract
+				outputMessage {
+					// destination to which the output message will be sent
+					sentTo('output')
+					// the body of the output message
+					body('''{ "bookName" : "foo" }''')
+					// the headers of the output message
+					headers {
+						header('BOOK-NAME', 'foo')
+					}
+				}
+			}
+		// end::method_trigger[]
+		// generated test should look like this:
+		when:
+			bookReturnedTriggered()
+		then:
+			def response = contractVerifierMessaging.receiveMessage('output')
+			response.headers.get('BOOK-NAME')  == 'foo'
+		and:
+			DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload))
+			JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo')
+	}
+
+	def "should generate tests triggered by a message"() {
+		given:
+		// tag::message_trigger[]
+			def dsl = Contract.make {
+				description 'Some Description'
+				label 'some_label'
+				// input is a message
+				input {
+					// the message was received from this destination
+					messageFrom('input')
+					// has the following body
+					messageBody([
+					        bookName: 'foo'
+					])
+					// and the following headers
+					messageHeaders {
+						header('sample', 'header')
+					}
+				}
+				outputMessage {
+					sentTo('output')
+					body([
+					        bookName: 'foo'
+					])
+					headers {
+						header('BOOK-NAME', 'foo')
+					}
+				}
+			}
+		// end::message_trigger[]
+
+		// generated test should look like this:
+
+		//given:
+		ContractVerifierMessage inputMessage = contractVerifierMessaging.create(
+				contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']),
+				[sample: 'header']
+		)
+		when:
+			contractVerifierMessaging.send(inputMessage, 'input')
+		then:
+			def response = contractVerifierMessaging.receiveMessage('output')
+			response.headers.get('BOOK-NAME')  == 'foo'
+		and:
+			DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload))
+			JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo')
+	}
+
+	def "should generate tests without destination, triggered by a message"() {
+		given:
+			def dsl = Contract.make {
+				label 'some_label'
+				input {
+					messageFrom('delete')
+					messageBody([
+					        bookName: 'foo'
+					])
+					messageHeaders {
+						header('sample', 'header')
+					}
+					assertThat('bookWasDeleted()')
+				}
+			}
+
+		// generated test should look like this:
+
+		//given:
+		ContractVerifierMessage inputMessage = contractVerifierMessaging.create(
+				contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']),
+				[sample: 'header']
+		)
+		when:
+			contractVerifierMessaging.send(inputMessage, 'delete')
+		then:
+			noExceptionThrown()
+			bookWasDeleted()
+	}
+
+	// BASE CLASS WOULD HAVE THIS:
+
+	@Autowired BookService bookService
+	@Autowired BookListener bookListener
+
+	void bookReturnedTriggered() {
+		bookService.returnBook(new BookReturned("foo"))
+	}
+
+	void bookWasDeleted() {
+		assert bookListener.bookSuccessfulyDeleted.get()
+	}
+
+}