Release 3.8.0 (#222)

Cornutum · Apr 14, 2022 · 211942b · 211942b
1 parent 3efe7a3
commit 211942b
Show file tree

Hide file tree

Showing 15 changed files with 261 additions and 43 deletions.
diff --git a/HowToDownload.md b/HowToDownload.md
@@ -63,6 +63,17 @@ The core models for Tcases objects. For the current version, see the [release no
 </dependency>
 ```
 
+#### [tcases-openapi-test](https://search.maven.org/search?q=g:org.cornutum.tcases%20AND%20a:tcases-openapi-test)
+(Since 3.8.0) Provides runtime support for tests generated by Tcases for OpenAPI. For the current version, see the [release notes](ReleaseNotes.md).
+
+```xml
+<dependency>
+  <groupId>org.cornutum.tcases</groupId>
+  <artifactId>tcases-openapi-test</artifactId>
+  <version>...</version>
+</dependency>
+```
+
 #### [tcases-rest-assured](https://search.maven.org/search?q=g:org.cornutum.tcases%20AND%20a:tcases-rest-assured)
 (Since 3.4.0) Provides a [`TestCaseWriter`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/restassured/RestAssuredTestCaseWriter.html)
 implementation for [REST Assured](https://github.com/rest-assured/rest-assured).

diff --git a/README.md b/README.md
@@ -5,10 +5,10 @@
 
 ## What's New? ##
 
-  * The latest version ([Tcases 3.7.2](ReleaseNotes.md#372)) is now available at the Maven Central Repository.
+  * The latest version ([Tcases 3.8.0](ReleaseNotes.md#380)) is now available at the Maven Central Repository.
     See [*How To Download Tcases*](HowToDownload.md) for download instructions.
 
-  * Tcases 3.7.2 provides improvements to Tcases for OpenAPI. See the [release notes](ReleaseNotes.md#372) for details.
+  * Tcases 3.8.0 introduces an important new feature for Tcases for OpenAPI: response validation. See the [release notes](ReleaseNotes.md#380) for details.
 
   * Having trouble with Tcases? Check out [these tips](./Troubleshooting-FAQs.md).
 

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,5 +1,32 @@
 # Release Notes #
 
+## 3.8.0 ##
+
+This release introduces an important new feature for Tcases for OpenAPI: response validation. By default, generated tests will
+now include code that checks the response data returned by API requests and verifies that all response requirements defined in the
+OpenAPI definition are satisfied.
+
+  * **Backward compatibility**
+
+    Because this change alters the behavior of generated tests and introduces new runtime dependencies, it is not strictly
+    compatible with previous releases. But if you want to maintain the previous behavior, you can use new command options
+    to [exclude response validation](tcases-openapi/Running-Api-Test-Cases.md#example-exclude-response-validation).
+
+  * **New test dependencies**
+
+    Generated tests that validate response requirements (the default) now depend on classes defined in the `tcases-openapi-test`
+    JAR. You must ensure that this JAR appears on the class path when compiling or executing these tests. For details,
+    see [*Set up test dependencies*](tcases-openapi/Running-Api-Test-Cases.md#set-up-test-dependencies).
+
+  * **New test resources**
+
+    Generated tests that validate response requirements must have access to the OpenAPI response definitions. Therefore, for
+    each generated test class, Tcases for OpenAPI now generates a corresponding *response definition file* that the test must
+    access as a resource at runtime. For details, see
+    [*Manage test resources*](tcases-openapi/Running-Api-Test-Cases.md#manage-test-resources).
+
+
+
 ## 3.7.2 ##
 
 This release provides the following improvements to Tcases for OpenAPI.

diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
   <groupId>org.cornutum.tcases</groupId>
   <artifactId>tcases</artifactId>
   <packaging>pom</packaging>
-  <version>3.7.3-SNAPSHOT</version>
+  <version>3.8.0</version>
 
   <name>Tcases</name>
   <description>Generates test cases from system input space models</description>

diff --git a/tcases-ant/pom.xml b/tcases-ant/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>3.7.3-SNAPSHOT</version>
+    <version>3.8.0</version>
   </parent>
 
   <artifactId>tcases-ant</artifactId>

diff --git a/tcases-cli/pom.xml b/tcases-cli/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.cornutum.tcases</groupId>
         <artifactId>tcases</artifactId>
-        <version>3.7.3-SNAPSHOT</version>
+        <version>3.8.0</version>
     </parent>
 
     <artifactId>tcases-cli</artifactId>

diff --git a/tcases-io/pom.xml b/tcases-io/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.cornutum.tcases</groupId>
         <artifactId>tcases</artifactId>
-        <version>3.7.3-SNAPSHOT</version>
+        <version>3.8.0</version>
     </parent>
 
     <artifactId>tcases-io</artifactId>

diff --git a/tcases-lib/pom.xml b/tcases-lib/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>3.7.3-SNAPSHOT</version>
+    <version>3.8.0</version>
   </parent>
 
   <artifactId>tcases-lib</artifactId>

diff --git a/tcases-maven-plugin/pom.xml b/tcases-maven-plugin/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>3.7.3-SNAPSHOT</version>
+    <version>3.8.0</version>
   </parent>
 
   <artifactId>tcases-maven-plugin</artifactId>

diff --git a/tcases-moco/pom.xml b/tcases-moco/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.cornutum.tcases</groupId>
         <artifactId>tcases</artifactId>
-        <version>3.7.3-SNAPSHOT</version>
+        <version>3.8.0</version>
     </parent>
 
     <artifactId>tcases-moco</artifactId>

diff --git a/tcases-openapi-test/pom.xml b/tcases-openapi-test/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.cornutum.tcases</groupId>
         <artifactId>tcases</artifactId>
-        <version>3.7.3-SNAPSHOT</version>
+        <version>3.8.0</version>
     </parent>
 
     <artifactId>tcases-openapi-test</artifactId>