Release 4.1.0 (#317)

kerrykimbrough · web-flow · commit f96420100c90 · 2025-03-28T18:45:06.000-05:00
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # Tcases: A Model-Based Test Case Generator #
 
-[![Maven](https://img.shields.io/badge/maven-4.0.5-green.svg)](https://search.maven.org/search?q=tcases-shell)
-[![Javadoc](https://img.shields.io/badge/javadoc-4.0.5-green.svg)](https://javadoc.io/doc/org.cornutum.tcases/tcases-shell)
+[![Maven](https://img.shields.io/badge/maven-4.1.0-green.svg)](https://search.maven.org/search?q=tcases-shell)
+[![Javadoc](https://img.shields.io/badge/javadoc-4.1.0-green.svg)](https://javadoc.io/doc/org.cornutum.tcases/tcases-shell)
 
 ## What's New? ##
-  * The latest version ([Tcases 4.0.5](ReleaseNotes.md#405)) is now available at the Maven Central Repository.
+  * The latest version ([Tcases 4.1.0](ReleaseNotes.md#410)) is now available at the Maven Central Repository.
     See [*How To Download Tcases*](HowToDownload.md) for download instructions.
 
   * Having trouble with Tcases? Check out [these tips](./Troubleshooting-FAQs.md).
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,5 +1,42 @@
 # Release Notes #
 
+## 4.1.0 ##
+
+This release provides the following improvements to Tcases for OpenAPI.
+
+  * **More info for TestWriter and TestCaseWriter authors**
+
+    Want to add support for non-Java test cases or different test frameworks? There's some things you need to know. And now you can find them
+    in the new guide to [_Using the TestWriter API_](tcases-openapi/Using-TestWriter-API.md).
+
+  * **TestWriter annotations**
+
+    To support test case generation for different test frameworks, new `TestWriter` implementations using the
+    [`ApiTestWriter`](https://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/ApiTestWriter.html)
+    annotation can be integrated at runtime.
+    Similarly, the
+    [`ApiTestCaseWriter`](https://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/ApiTestCaseWriter.html)
+    and
+    [`ApiTestTarget`](https://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/ApiTestTarget.html)
+    annotations can be used to integrate new `TestCaseWriter` and `TestTarget` implementations, respectively. For details, see
+    [_Using the TestWriter API_](tcases-openapi/Using-TestWriter-API.md).
+
+  * **Exclude success or failure cases**
+
+    It can be helpful to generate success cases and failure cases separately. For example, you might want to generate success cases
+    based on OpenAPI examples but generate random failures based on OpenAPI schemas. (See discussion [318](https://github.com/Cornutum/tcases/discussions/318).)
+    To exclude success cases, use the `-xs` option of the `tcases-api-test` command (or `-DexcludeSuccess=true` if using the Maven `tcases:api-test` goal).
+    Similarly, to exclude failure cases, use the `-xf` option of the `tcases-api-test` command (or `-DexcludeFailure=true` if using the Maven `tcases:api-test` goal).
+
+  * **Fixed generated base class import** [[313](https://github.com/Cornutum/tcases/issues/313)]
+
+    Yikes! When the base class for the generated test class is in a different package, the generated `import` statement
+    was missing a final ';'. But not anymore.
+  
+  * **Upgraded dependencies**
+
+    Upgraded to swagger-parser 2.1.25.
+
 ## 4.0.5 ##
 
 This release provides the following improvements.
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
   <groupId>org.cornutum.tcases</groupId>
   <artifactId>tcases</artifactId>
   <packaging>pom</packaging>
-  <version>4.1.0-SNAPSHOT</version>
+  <version>4.1.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>4.1.0-SNAPSHOT</version>
+    <version>4.1.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>4.1.0-SNAPSHOT</version>
+        <version>4.1.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>4.1.0-SNAPSHOT</version>
+        <version>4.1.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>4.1.0-SNAPSHOT</version>
+    <version>4.1.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>4.1.0-SNAPSHOT</version>
+    <version>4.1.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>4.1.0-SNAPSHOT</version>
+        <version>4.1.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>4.1.0-SNAPSHOT</version>
+        <version>4.1.0</version>
     </parent>
 
     <artifactId>tcases-openapi-test</artifactId>
diff --git a/tcases-openapi/Running-Api-Test-Cases.md b/tcases-openapi/Running-Api-Test-Cases.md
@@ -376,7 +376,7 @@ such frameworks. For test developers, such frameworks generally define how to de
 their execution. And they are general-purpose, equally applicable for all kinds of testing. There is nothing about them that
 specifically supports API testing. To create tests for a different test framework, create a new subclass of the basic
 [`TestWriter`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/TestWriter.html) class.
-Several [helpful utilities](#some-helpful-utilities) are available to make this easier.
+For details, see [_Using the TestWriter API_](./Using-TestWriter-API.md).
 
 Also, API tests must rely on an additional set of <A name="request-execution">"request execution"</A> interfaces. These are
 the interfaces used to construct a request message, deliver it to an API server, and collect the resulting response. Here, too,
@@ -385,9 +385,7 @@ candidates range from basic APIs like [HttpClient](http://hc.apache.org/httpcomp
 domain-specific micro-languages like [REST Assured](https://github.com/rest-assured/rest-assured). To create tests that use a
 different execution interface, create a new implementation of the
 [`TestCaseWriter`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/TestCaseWriter.html) interface.
-`TestCaseWriter` implementations often start with a subclass of
-[`BaseTestCaseWriter`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/BaseTestCaseWriter.html).
-Several [helpful utilities](#some-helpful-utilities) are available to make this easier.
+For details, see [_Using the TestWriter API_](./Using-TestWriter-API.md).
 
 #### Creating an API test, step-by-step ####
 
@@ -406,20 +404,6 @@ Here's a step-by-step outline of how to use the TestWriter API to convert an Ope
      defines the test source file to be generated. Note that this `TestTarget` must be compatible with the `TestWriter`.
   1. Call [`TestWriter.writeTest()`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/TestWriter.html#writeTest-S-T-).
 
-#### Some helpful utilities ####
-
-  - **To serialize a request parameter** according to the `style` and `explode` properties specified in the OpenAPI definition, use the public methods
-    of the [`TestWriterUtils`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/TestWriterUtils.html) class,
-    such as [`getQueryParameters()`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/TestWriterUtils.html#getQueryParameters-org.cornutum.tcases.openapi.resolver.ParamData-).
-
-  - **To serialize form data** using the `application/x-www-form-urlencoded` media type, use the
-    [`FormUrlEncoder`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/encoder/FormUrlEncoder.html).
-
-  - **To serialize request body data** using another media type specified in the OpenAPI definition, use a
-    [`DataValueConverter`](http://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/encoder/DataValueConverter.html).
-    The `BaseTestCaseWriter` class automatically registers converters for many common media types. Alternatively, create and register your own
-    implementation.
-
 ## Running generated tests ##
 
 By default, certain dependencies are required to compile and execute tests generated by Tcases for OpenAPI. This section
diff --git a/tcases-openapi/Using-TestWriter-API.md b/tcases-openapi/Using-TestWriter-API.md
@@ -394,7 +394,8 @@ Here are the requirements for implementing a new TestWriter.
 
   <a name="apitestwriter"></a>
   For a TestWriter to be discovered at runtime by the `tcases-api-test` command (or the Maven `tcases:api-test` goal) the
-  class definition must have the `ApiTestWriter` annotation. For example:
+  class definition must have the [`ApiTestWriter`](https://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/ApiTestWriter.html)
+  annotation. For example:
 
   ```java
   /**
@@ -447,7 +448,8 @@ Here are the requirements for implementing a new TestCaseWriter.
 
   <a name="apitestcasewriter"></a>
   For a TestCaseWriter to be discovered at runtime by the `tcases-api-test` command (or the Maven `tcases:api-test` goal) the
-  class definition must have the `ApiTestCaseWriter` annotation. For example:
+  class definition must have the [`ApiTestCaseWriter`](https://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/ApiTestCaseWriter.html)
+  annotation. For example:
 
   ```java
   @ApiTestCaseWriter( name="restassured")
@@ -490,7 +492,8 @@ Here are the requirements for implementing a new TestTarget.
 - **Use the `ApiTestTarget` annotation**
 
   For a TestTarget to be discovered at runtime by the `tcases-api-test` command (or the Maven `tcases:api-test` goal) the
-  class definition must have the `ApiTestTarget` annotation. For example:
+  class definition must have the [`ApiTestTarget`](https://www.cornutum.org/tcases/docs/api/org/cornutum/tcases/openapi/testwriter/ApiTestTarget.html)
+  annotation. For example:
 
   ```java
   /**
diff --git a/tcases-openapi/pom.xml b/tcases-openapi/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.cornutum.tcases</groupId>
         <artifactId>tcases</artifactId>
-        <version>4.1.0-SNAPSHOT</version>
+        <version>4.1.0</version>
     </parent>
 
     <artifactId>tcases-openapi</artifactId>
@@ -54,7 +54,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.build.date>${maven.build.timestamp}</project.build.date>
         <maven.build.timestamp.format>yyyy-MM-dd</maven.build.timestamp.format>
-        <tcases.maven.version>4.0.5</tcases.maven.version>
+        <tcases.maven.version>4.1.0</tcases.maven.version>
     </properties>
 
     <build>
diff --git a/tcases-rest-assured/pom.xml b/tcases-rest-assured/pom.xml
@@ -7,7 +7,7 @@
     <parent>
         <groupId>org.cornutum.tcases</groupId>
         <artifactId>tcases</artifactId>
-        <version>4.1.0-SNAPSHOT</version>
+        <version>4.1.0</version>
     </parent>
 
     <artifactId>tcases-rest-assured</artifactId>
diff --git a/tcases-shell/pom.xml b/tcases-shell/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>org.cornutum.tcases</groupId>
     <artifactId>tcases</artifactId>
-    <version>4.1.0-SNAPSHOT</version>
+    <version>4.1.0</version>
   </parent>
 
   <artifactId>tcases-shell</artifactId>
