sivaprasadreddy / generator-springboot Goto Github PK

View Code? Open in Web Editor NEW

213.0 213.0 74.0 4.98 MB

Yeoman based Spring Boot Microservice generator

Home Page: https://www.npmjs.com/package/generator-springboot

License: MIT License

JavaScript 39.07% Java 59.71% Dockerfile 0.90% Shell 0.31%

microservices spring-boot yeoman yeoman-generator

generator-springboot's Introduction

Hey there, I'm Siva! 👋

💻 Building Software since 2006
💬 Extensively worked on Java, SpringBoot, Docker, Kubernetes or any tech related stuff.
🌱 Interested in learning new technologies.

Languages and Tools:

Key Repositories

generator-springboot - Yeoman based Spring Boot Microservice generator
Tomato Architecture - A common sense driven approach to software architecture: Blog Post
testcontainers-samples - Sample Java projects using Testcontainers
IntelliJ Live Templates - IntelliJ Live Templates for Spring Boot, JUnit, Mockito, AssertJ, Lombok, etc.
spring-security-oauth2-microservices-demo - Code for Securing Microservices with Spring Security OAuth2
spring-boot-microservices-series - Code for SpringBoot MicroServices Blog Series
sivalabs-youtube-code-samples - Code samples for my YouTube Videos
java-testing-made-easy - Code for Java Testing Made Easy YouTube Tutorial Series
TechBuzz - A Spring Boot application to share bookmarks
spring-boot-jooq-demo - Code for Spring Boot + jOOQ Tutorial Series

generator-springboot's People

Contributors

Stargazers

Watchers

Forkers

jerreddy otoukebri akuma julionovoaodicio cessatl angelsplato ludoo0d0a karthikchejerla hiringtechtalents mohamed224 bhavyakamboj avi202020 xwolf-wang rom3r4 eaz venkatesh82 aapiro rameshrasaiyan openmicrostacks purnachand99 bbahaida norberto-enomoto rteja88 amitkurud anil-bt backbase keeplearningandtrying matheusemm gabriellhuver iuriimattos2 yinzhidong jshingler ustcck robinmin microcafe hahalulu marcos-rios jgecen srini-555 mohamdi senojydnas khamdan jimmyjose spring-boot-framework jijuta w3farid jsfix-ci gaboxlive oumarxy blueoceandevops abdullahshariargit guhtiagosilva edneyego vinirib madhavanananthan kchobantonov jiman94 sergiopino toannv6895 wenpktalk sgoriainov julianseo sagar-rout makwasi1 devcode961 shinchan79 jewel73 rajadilipkolli phenoxp basefork sujin-yang

generator-springboot's Issues

Add support for spring boot 3 observability

Observability is changed in spring boot 3 using micrometer. Add support for the same

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error: expecting end of expression or separator near "labe

Skip adding PagedResult.java when liquibase or flyway migrationversion is greater than 2

We need to skip adding below file when Liquibase or flyway is already generated.

model/response/PagedResult.java

WorkAround : When prompted click on overwrite option

Write a blog post on how to build Yeoman Generator so that others can contribute

Upgrade the ELK Stack to 8.x version in docker-compose

Please upgrade the ELK stack to 8.x in docker-compose, There are breaking changes in v7 and V8.

Just upgrading the ELK stack from 6.2.2 to latest version is not working.

Creating Controller with Custom name is not importing packages correctly

I have tried to create Controller with name Order, it has created class files correctly but the import statements in controller and service class are wrong and pointing to customer package.

Expectation : import statements of entities, Service and Respository in controller should be pointing to correct path.

Cannot run command as root user

Installed all the prerequisites and when I try to create a new project using yo springboot command, I get an error

# yo springboot
/usr/lib/node_modules/yo/node_modules/conf/index.js:128
			throw err;
			^

Error: EACCES: permission denied, open '/root/.config/insight-nodejs/insight-yo.json'
    at Object.openSync (fs.js:440:3)
    at Object.readFileSync (fs.js:342:35)
    at Conf.get store [as store] (/usr/lib/node_modules/yo/node_modules/conf/index.js:108:18)
    at Conf.get (/usr/lib/node_modules/yo/node_modules/conf/index.js:47:27)
    at Insight.get optOut [as optOut] (/usr/lib/node_modules/yo/node_modules/insight/lib/index.js:52:22)
    at Object.<anonymous> (/usr/lib/node_modules/yo/lib/cli.js:205:48)
    at Module._compile (internal/modules/cjs/loader.js:971:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1011:10)
    at Module.load (internal/modules/cjs/loader.js:822:32)
    at Function.Module._load (internal/modules/cjs/loader.js:730:14) {
  errno: -13,
  syscall: 'open',
  code: 'EACCES',
  path: '/root/.config/insight-nodejs/insight-yo.json'
}

Changed the permission to 777 for the file

# chmod 777 /root/.config/insight-nodejs/insight-yo.json
# ls -l /root/.config/insight-nodejs/insight-yo.json
-rwxrwxrwx 1 root root 29 Feb 17 13:29 /root/.config/insight-nodejs/insight-yo.json
# cat /root/.config/insight-nodejs/insight-yo.json
{
	"clientId": 729298861707
}

Cant even run as sudo

# sudo yo springboot
/usr/lib/node_modules/yo/node_modules/conf/index.js:128
			throw err;
			^

Error: EACCES: permission denied, open '/root/.config/insight-nodejs/insight-yo.json'
    at Object.openSync (fs.js:440:3)
    at Object.readFileSync (fs.js:342:35)
    at Conf.get store [as store] (/usr/lib/node_modules/yo/node_modules/conf/index.js:108:18)
    at Conf.get (/usr/lib/node_modules/yo/node_modules/conf/index.js:47:27)
    at Insight.get optOut [as optOut] (/usr/lib/node_modules/yo/node_modules/insight/lib/index.js:52:22)
    at Object.<anonymous> (/usr/lib/node_modules/yo/lib/cli.js:205:48)
    at Module._compile (internal/modules/cjs/loader.js:971:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1011:10)
    at Module.load (internal/modules/cjs/loader.js:822:32)
    at Function.Module._load (internal/modules/cjs/loader.js:730:14) {
  errno: -13,
  syscall: 'open',
  code: 'EACCES',
  path: '/root/.config/insight-nodejs/insight-yo.json'
}

support spring cloud AWS 2.3 and deprecate 2.2

we need to make changes as per this post for supporting AWS 2.3

Adds support for grafana loki stack

Grafana loki is used as an alternative to elk in few organizations. Support for the same in generator

Add option to generate JWT Security configuration for microservice generator

sonar.properties is reflecting values of gradle build instead of maven build

Below are the properties which needs to be adjusted as per maven project

sonar.java.checkstyle.reportPaths=build/reports/checkstyle/main.xml
sonar.java.pmd.reportPaths=build/reports/pmd/main.xml
sonar.java.spotbugs.reportPaths=build/reports/spotbugs/main.html

Adds Junits for repository layer using @Datajpatest

Create infrastructure to create the repository slice testing.

Involve schema validation test in the setup

Add feature to generate Gateway service

Support for other Liquibase migration formats (yaml, sql)

It might be of value to liquibase users to be able to write their migration in whatever format they are used to

Enable Github's Discussion

Enabling Github's Discussion will help to chat to the owner of repository , instead of raising Issues for all.

Code Clean up for 0.1.3 version

Considering the new features introduced in Spring Boot 3.1.0, I have the following things that can clean up our code generation process:

Do we need Spring Cloud BOM Configuration?
Remove milestone and snapshot reposiotry configurations
Do we need .editorconfig?
Rename ErrorDetailProblemHandlingControllerAdvice to GlobalExceptionHandler and move into com.mycompany.<service>.config package.
Shall we remove application-heroku.properties, application-local.properties?
Shall we remove generating h2 db migration scripts by default and provide H2 as one of the database option?
When using MySQL database tests are failing with SSL errors.

Add option to generate ELK configuration for microservice generator

V1.16.0

Use fluent JPA setters
Moving FindQuery to pojo mapper in service package to util, for re-use purpose
provide various mappers(mapstruct/modelmapper,etc) in the lines of liquibase or flyway
use loggable annotation in service layer

Add support for restclients

Support for calling API using rest clients

Options are resttemplate , webclient and declarative clients

Automate npm release process

Current release process is manual which should be automated

Feature request : project name CLI

That will be nice to be able to specified application name as option in CLI usage :

yo springboot myservice

Fix database migration script version number increment issue

Add feature to generate classic webapp with Thymeleaf support

Add License

You have done cool work.

I would like to fork your project and use that inside our company, but I can not due to missing license.

Github says missing license does not allow me to use your code as a base.

If you willing to let me use the code, add license using this guide.
I'd do it for you, but I have no clue what type of license you would like to have. :)
Thank you!

Add tests for performing sanity checks

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

docker-compose

generators/server/templates/app/docker/docker-compose-elk.yml

docker.elastic.co/elasticsearch/elasticsearch 8.12.2

docker.elastic.co/logstash/logstash 8.12.2

docker.elastic.co/kibana/kibana 8.12.2

generators/server/templates/app/docker/docker-compose-monitoring.yml

grafana/grafana 10.2.3

prom/prometheus v2.49.1

dockerfile

.gitpod.Dockerfile

generators/server/templates/app/Dockerfile

eclipse-temurin 17.0.10_7-jre-focal

eclipse-temurin 17.0.10_7-jre-focal

github-actions

.github/workflows/build.yml

actions/checkout v4

actions/setup-node v4

.github/workflows/docs.yml

actions/checkout v4

actions/setup-python v4

generators/server/templates/app/.github/workflows/gradle.yml

actions/checkout v4

actions/setup-java v3

generators/server/templates/app/.github/workflows/maven.yml

actions/checkout v4

actions/setup-java v3

gradle

generators/server/templates/gradle/gradle.properties

generators/server/templates/gradle/code-quality.gradle

generators/server/templates/gradle/owasp.gradle

generators/server/templates/gradle/settings.gradle

generators/server/templates/gradle/build.gradle

gradle-wrapper

generators/common/files/gradle/gradle/wrapper/gradle-wrapper.properties

gradle 8.7

maven-wrapper

generators/common/files/maven/.mvn/wrapper/maven-wrapper.properties

maven 3.9.6

maven-wrapper 3.2.0

npm

package.json

chalk 4.1.2

lodash 4.17.21

shelljs 0.8.5

yeoman-environment 3.19.3

yeoman-generator 5.10.0

chai 4.4.1

fs-extra 11.2.0

mocha 10.3.0

sinon 17.0.1

yeoman-assert 3.1.1

yeoman-test 6.3.0

Check this box to trigger a request for Renovate to run again on this repository

DTO

Do you intend to include the generation of DTO's?

Generate docker-compose file for Zipkin

Remove unused property values in Application.java

Also annotate with @NestedConfiguration properties for cors configuration else it won't be picked in native images

Create sub-generator to generate CRUD operations

Create sub-generator to generate JPA entity, repository, service, and controller with CRUD operations.

Use @DynamicPropertySource instead of ApplicationContextInitializer in Junits

Use @DynamicPropertySource like here instead of ApplicationContextInitializer in Junits when using Containers for setting the value in Junit tests example

Also use @testcontainers annotation in conjunction with @container annotation to start the container.

If we need to use the database across all Junits then we need to create ShareContainer like here

Suggest which is better way to handle?

I will submit PR for this

Integrate with SpringBoot Testcontainers starter

https://github.com/testcontainers/testcontainers-spring-boot

Add option to generate Prometheus, Grafana configuration for microservice generator

Improper db table names when using CamelCase variable name

When creating entities with CamelCase scheme, the @Table entity is created with an improper naming scheme.
For eg. when issuing
yo springboot:controller ShoppingCart --base-path /api/shoppingcart , then entity class has @Table(name = "shopping carts") which causes an InvalidDataAccessResourceUsageException when running the tests

Add option to generate docker-compose files for microservice generator

Local changes to Yeoman Generator

I have used your generator as a base and have made some customization to address to organizational needs. I tested it locally using npm link and it worked as expected.
Committed the changes in my github repo. Now post taking the pull from git and running it i don't see my changes reflecting.
Please help!!

remove dependency on JCenter for dependencies as it is sunsetting

jcenter is about to sunset in may 2021, I know that there is a huge dependency for gradle plugins on jcenter. We should slowly migrate to mavencentral

Feature request: Give option to generate properties in yaml format

Generator is generating project by default in properties file. Please consider giving option to choose configuration file format.

Confusion with pageNumber on Pagination

Affected Branch : 0.1.1

Glad that we now have pagination for entities, but I think the setting the page number on response will lead to confusion as the page number get increment on response.

generator-springboot/generators/controller/templates/app/src/main/java/model/response/PagedResult.java

Line 26 in ba6a56e

page.getNumber() + 1,

This may lead to confusion as the we make the request for the first page, with index 0 and is returned the pageNumber 1. this is quite evident in the controller test where we make requires for 0th page and get returned the page with pageNumber 1,

generator-springboot/generators/controller/templates/app/src/test/java/web/controllers/ControllerTest.java

Lines 60 to 68 in ba6a56e

    
           given(<%= entityVarName %>Service.findAll<%= entityName %>s(0, 10, "id", "asc")) 
        
                   .willReturn(<%= entityVarName %>PagedResult); 
        
           this.mockMvc 
        
                   .perform(get("<%= basePath %>")) 
        
                   .andExpect(status().isOk()) 
        
                   .andExpect(jsonPath("$.data.size()", is(<%= entityVarName %>List.size()))) 
        
                   .andExpect(jsonPath("$.totalElements", is(3))) 
        
                   .andExpect(jsonPath("$.pageNumber", is(1)))

Can we have a look into this?

Run google-java-format after project generation

Formatting the templates as per google java format manually is a painful process especially when rendering something conditionally. So, a better approach could be running google java format goal after project code generation depending on selected build tool.

	given(<%= entityVarName %>Service.findAll<%= entityName %>s(0, 10, "id", "asc"))
	.willReturn(<%= entityVarName %>PagedResult);

	this.mockMvc
	.perform(get("<%= basePath %>"))
	.andExpect(status().isOk())
	.andExpect(jsonPath("$.data.size()", is(<%= entityVarName %>List.size())))
	.andExpect(jsonPath("$.totalElements", is(3)))
	.andExpect(jsonPath("$.pageNumber", is(1)))