Service Virtualization Feature enhancement by elans3 · Pull Request #196 · OpenAPITools/openapi-generator

elans3 · 2018-06-01T06:55:51Z

I am one of the swagger/Open API user and would like to be a future contributor to the community. I had started developing a virtualized service idea and donate the code to Swagger community from the beginning.

How can we use codegen project into Service Virtualization, As it holds tremendous potential to help testers boost test automation and keep pace with Agile and DevOps demands. If Developer/Tester being pressured to test faster and/or earlier in each release cycle (e.g., “shift left”), Service Virtualization could help advance development team’s Continuous Testing and development efforts and lot more in the API Contract driven world"

I have been working on project and had a requirement to develop a virtualized service. I had customized swagger codegen to create a virtualized service generation for the any given REST Yaml contract with JSON support.

How to setup virtualized service for all your Rest contracts in less then 10 minutes...
Required Info:
https://github.com/elans3/openapi-generator/blob/master/modules/openapi-generator-virtualan/src/main/resources/java-config.json

Setup Instruction: (All steps are same used as Swagger codegen as reference)
https://virtualmockservice.blogspot.com/2018/04/hi-everyone-in-this-microservice-world.html

Please let me know if you need any additional details. I would be eager to help integrate with codegen project.
Thanks,
Elan

Open Virtualan API Implementation

Menu change

Supporting files for Virtual service setup

…rator # Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

…rator

Merge the latest code

Merge

…enerator into virtual-service

Virtual service

jmini · 2018-06-05T05:39:36Z

Sorry to ask stupid question, but how does this project is related to openapi-generator? I do not see where openapi-generator is used. What is the dependencies between the "Service Virtualization Feature" and "OpenAPI Generator"...

@wing328: maybe we could publish it as a new project inside the https://github.com/OpenAPITools organization?

@elans3 What do you think about this proposition? Can you give me more details?

elans3 · 2018-06-05T22:04:29Z

@jmini

Reason would be - Virtualized service had developed using the Open API Code generation project with openapi-generator-cli CLI tool.

Refer the codegen files that would generate as "Virtualized" service.

https://github.com/elans3/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaSpring/apiControllerMockLogic.mustache
https://github.com/elans3/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaSpring/apiMockLogic.mustache
During code generation need to set choice for Virtualized service and would help create the Virtualized service of all Resources/YAML used to generate.
- "virtualService": true (java-config.json) - Currently it works only with spring
- java -jar openapi-generator-cli.jar generate -i petstore.yaml --generator-name spring -o mockservice -c java-config.json
"openapi-generator-virtualan" project would developed on top of the Open API Code generation project. This is supporting module that helps to Setup and Access all virtualized services.
- Creating the data-setup for the selected Service via UI - Look and feel similar to Swagger UI.
- Expose "Virtualized Service" as service(OAS API). Utilized

Automated API Testing.

Using cucumber setup the service Data in the Virtualized service to Setup data for the Resource-API Call would be tested
Run the API Calls and Validate the response.
Will be creating some testcases ASAP using Cucumber with this deliverable.
Certify the functional requirement in DEV Environment without Real Implemented services .
and Etc..

- Maven plugin related changes - Samples added

Virtual service Changes

Build issue resolved - Tab space was removed..

virtualan-plugin integration with open api tool.

elans3 · 2018-08-30T05:48:35Z

Virtualan had released under io.virtualan.virtualan-plugin with 1.0.0. I had integrated the Open API Tools with Spring boot apps with Virtualan. Now it is available via https://oss.sonatype.org/content/repositories/releases/io/virtualan/virtualan-plugin/1.0.0 - the first version of virtualan..
I had updated my pull request(#196) with virtualan-plugin. Hope this should be good to proceed further.. Let me know anything else needed.

jmini · 2018-08-30T05:59:07Z

Where is the repository holding the sources?

Why are you not hosting your released jar on maven central?

elans3 · 2018-08-30T06:06:03Z

Yes it is available in the maven repo. https://repo.maven.apache.org/maven2/io/virtualan/virtualan-plugin/
Source Code: I am hosting under my own organisation(https://github.com/elan-venture/virtualan).

wing328 · 2018-09-04T04:20:37Z

bin/springboot-virtualan-petstore-server.json

+    "artifactId": "springboot-virtualan",
+    "library": "spring-boot",
+    "virtualService": true,
+	"modelPackage" : "org.openapitools.virtualan.model",


Minor suggestion: use spaces instead of tab

Removed the tab spaces

wing328 · 2018-09-04T04:21:42Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java

    public static final String GENERATE_MODEL_DOCS = "generateModelDocs";

+    public static final String VIRTUAL_SERVICE = "virtualService";
+    public static final String VIRTUAL_SERVICE_DOCS = "virtualServiceDocs";


minor suggestion: I would suggest replace with virtualServiceDocs with a better description of the service

Updated as Suggested

wing328 · 2018-09-04T04:24:50Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

        cliOptions.add(CliOption.newBoolean(ASYNC, "use async Callable controllers", async));
        cliOptions.add(CliOption.newBoolean(REACTIVE, "wrap responses in Mono/Flux Reactor types (spring-boot only)", reactive));
        cliOptions.add(new CliOption(RESPONSE_WRAPPER, "wrap the responses in given type (Future,Callable,CompletableFuture,ListenableFuture,DeferredResult,HystrixCommand,RxObservable,RxSingle or fully qualified type)"));
+        cliOptions.add(CliOption.newBoolean(VIRTUAL_SERVICE, "Default generate without virtual service"));


I would suggest adding "https://github.com/elan-venture/virtualan/wiki" to explain the virtual service

e.g. "use virtual service: https://github.com/elan-venture/virtualan/wiki"

Updated with Wiki reference.

wing328 · 2018-09-04T04:25:55Z

modules/openapi-generator/src/main/resources/JavaSpring/libraries/spring-boot/pom.mustache

+		    <version>1.5.9.RELEASE</version>
+		</dependency>
+    <!-- END Virtual Service API support -->
+{{/virtualService}}       


To make it consistent with the rest of the pom file, please use spaces instead of tabs

Removed the Tab spaces

Latest changes

Updated the all review comments and removed all tab spaces.

wing328 · 2018-09-04T10:39:41Z

@elans3 I ran /bin/sh ./bin/springboot-virtualan-petstore-server.sh and got the following update:

--- a/samples/server/petstore/springboot-virtualan/README.md
+++ b/samples/server/petstore/springboot-virtualan/README.md
@@ -1,29 +1,18 @@
 # OpenAPI generated server

-Spring Boot Virtual API Service using Virtulan: https://github.com/elan-venture/virtualan/wiki
+Spring Boot Server


 ## Overview
-This virtual service was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
-By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a virtual service.
-This is an example of building a OpenAPI-enabled virtual service in Java using the SpringBoot framework.
+This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
+By using the [OpenAPI-Spec](https://openapis.org), you can easily generate a server stub.
+This is an example of building a OpenAPI-enabled server in Java using the SpringBoot framework.

-The underlying library integrating OpenAPI to SpringBoot is [springfox](https://github.com/springfox/springfox) and Virtualan (https://github.com/elan-venture/virtualan)
+The underlying library integrating OpenAPI to SpringBoot is [springfox](https://github.com/springfox/springfox)

-Build:
+Start your server as a simple java application

-  mvn clean install
+You can view the api documentation in swagger-ui by pointing to
+http://localhost:80/

-Run using standalone JAR:
-
-  java -jar target/virtualan-spring-controller-example-1.0.0.jar
-
-Invoke User REST service:
-
-  curl http://localhost/users
-
-Invoke Virtualan UI:
-
-Navigate to http://localhost/virtualan-ui.html.
-
-More details about the user interface refer- https://github.com/elan-venture/virtualan/wiki
\ No newline at end of file
+Change default port value in application.properties
\ No newline at end of file

Looks like all the Virtualan related information are gone. Did you see similar update when running the script locally?

Updated the ReadMe section.

elans3 · 2018-09-04T23:25:25Z

@wing328.. Updated the code to generate the "README.md" including Virtualan information on the fly.
Hope it resolves now :)

New line removed to fix the build issue. :)

Virtualan included in the petstore build script

wing328 · 2018-09-05T08:38:03Z

@elans3 thanks for the quick fix. The change looks good to me.

elans3 · 2018-09-09T17:14:02Z

@wing328.. Thank you!!!

wing328 · 2018-10-02T02:22:16Z

@elans3 thanks again for the PR, which is included in the v3.3.0 minor release: https://twitter.com/oas_generator/status/1046941449609068544

elans3 · 2018-10-03T00:29:58Z

Thank you!!!

* Open Virtualan API Implementation * Menu change * Delete .swagger-codegen-ignore * Delete jsonbeautifier.html * Supporting files for Virtual service setup * CRLF removed * Unwanted new lines are removed * Build issues resolved * Build issue resolved * Removed Logger statement * Logger removed * Updated * Codegen virtual services samples for petstore.yaml * - Code Revamp and Clean up - Maven plugin related changes - Samples added * Tab space removed.. * Annotation based Service virtualization * Open API code generator changes * Virtualan samples added with Sprint boot app. * Build issue resolved * Removed unwanted files * Updated with version 3.0.3 SNAPSHOT * Reverted the options for virtual service in global and not needed now. * virtualan-plugin integration with open api tool. * Updated the all review comments and removed all tab spaces. * Updated the ReadMe generator section. * New line removed to fix the build issue. * Spring boot virtualan included in the spring build script * Included in the spring-all-petstore script

elans3 added 11 commits May 31, 2018 19:41

Open Virtualan API Implementation

7cb2b71

Merge pull request #1 from elans3/virtual-service

97abd3b

Open Virtualan API Implementation

Menu change

2e16b77

Merge pull request #2 from elans3/virtual-service

71c1293

Menu change

Delete .swagger-codegen-ignore

4f16176

Delete jsonbeautifier.html

76f74d2

Supporting files for Virtual service setup

96ef7fc

Merge pull request #3 from elans3/virtual-service

302c479

Supporting files for Virtual service setup

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

ea9130d

…rator # Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

CRLF removed

a40e1bf

Merge branch 'master' of https://github.com/OpenAPITools/openapi-gene…

197dbdb

…rator

wing328 added this to the 3.0.1 milestone Jun 2, 2018

wing328 mentioned this pull request Jun 2, 2018

Dashboard showing build for master of original repo and forked repo Shippable/support#4370

Closed

elans3 added 11 commits June 2, 2018 11:18

Unwanted new lines are removed

e71d1a3

Build issues resolved

df78ce4

Build issue resolved

657cb69

Merge pull request #6 from elans3/master

709781e

Merge the latest code

Merge pull request #5 from OpenAPITools/master

10249d7

Merge

Removed Logger statement

fce8516

Logger removed

c79fe31

Merge branch 'virtual-service' of https://github.com/elans3/openapi-g…

fde1c9f

…enerator into virtual-service

Updated

b425623

Merge pull request #7 from elans3/virtual-service

da2bf6e

Virtual service

Codegen virtual services samples for petstore.yaml

dd7f82b

elans3 added 4 commits June 5, 2018 22:17

- Code Revamp and Clean up

868d9b2

- Maven plugin related changes - Samples added

Merge pull request #9 from elans3/virtual-service

79c4339

Virtual service Changes

Tab space removed..

f11f67d

Merge pull request #10 from elans3/virtual-service

58fac89

Build issue resolved - Tab space was removed..

elans3 added 2 commits August 30, 2018 00:07

virtualan-plugin integration with open api tool.

32e9c3a

Merge pull request #23 from elans3/vir-integration

10b6d1f

virtualan-plugin integration with open api tool.

wing328 reviewed Sep 4, 2018

View reviewed changes

elans3 added 3 commits September 3, 2018 23:51

Merge pull request #24 from OpenAPITools/master

baa95cc

Latest changes

Updated the all review comments and removed all tab spaces.

bb5b147

Merge pull request #25 from elans3/vir-integration

120c2c2

Updated the all review comments and removed all tab spaces.

wing328 added this to the 3.3.0 milestone Sep 4, 2018

elans3 added 2 commits September 4, 2018 18:21

Updated the ReadMe generator section.

d79ca5a

Merge pull request #26 from elans3/vir-integration

05bd264

Updated the ReadMe section.

elans3 added 5 commits September 4, 2018 22:45

New line removed to fix the build issue.

cd15e5c

Merge pull request #27 from elans3/vir-integration

754394b

New line removed to fix the build issue. :)

Spring boot virtualan included in the spring build script

7f10c90

Included in the spring-all-petstore script

673039d

Merge pull request #28 from elans3/vir-integration

489d7cb

Virtualan included in the petstore build script

wing328 merged commit 3abeb82 into OpenAPITools:master Sep 5, 2018

Uh oh!

Conversation

elans3 commented Jun 1, 2018

Uh oh!

jmini commented Jun 5, 2018

Uh oh!

elans3 commented Jun 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elans3 commented Aug 30, 2018

Uh oh!

jmini commented Aug 30, 2018

Uh oh!

elans3 commented Aug 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Sep 4, 2018

Uh oh!

elans3 commented Sep 4, 2018

Uh oh!

wing328 commented Sep 5, 2018

Uh oh!

elans3 commented Sep 9, 2018

Uh oh!

wing328 commented Oct 2, 2018

Uh oh!

elans3 commented Oct 3, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

elans3 commented Jun 5, 2018 •

edited

Loading

elans3 commented Aug 30, 2018 •

edited

Loading