Skip to content

Commit

Permalink
Add a simple codestart for hibernate orm rest data in order to genera…
Browse files Browse the repository at this point in the history
…te REST resources for a simple entity
  • Loading branch information
aureamunoz committed Feb 5, 2024
1 parent de74fa3 commit 52e8ad9
Show file tree
Hide file tree
Showing 10 changed files with 128 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{#include readme-header /}

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: hibernate-orm-rest-data-codestart
ref: hibernate-orm-rest-data
tags: extension-codestart
type: code
metadata:
title: REST Data with Panache
description: Generating Jakarta REST resources with Panache
related-guide-section: https://quarkus.io/guides/rest-data-panache
language:
base:
dependencies:
- io.quarkus:quarkus-hibernate-orm-rest-data-panache
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package org.acme;

import io.quarkus.hibernate.orm.panache.PanacheEntity;
import jakarta.persistence.Entity;


/**
* Example JPA entity defined as a Panache Entity.
* An ID field of Long type is provided, if you want to define your own ID field extends <code>PanacheEntityBase</code> instead.
*
* This uses the active record pattern, you can also use the repository pattern instead:
* {@see https://quarkus.io/guides/hibernate-orm-panache#solution-2-using-the-repository-pattern}.
*
* Usage (more example on the documentation)
*
* \{@code
* public void doSomething() {
* MyEntity entity1 = new MyEntity();
* entity1.field = "field-1";
* entity1.persist();
*
* List<MyEntity> entities = MyEntity.listAll();
* }
* }
*/
@Entity
public class MyEntity extends PanacheEntity {
public String field;
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package org.acme;

import io.quarkus.hibernate.orm.rest.data.panache.PanacheEntityResource;

public interface MyEntityResource extends PanacheEntityResource<MyEntity, Long> {
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ metadata:
- "data"
- "web"
status: "stable"
codestart:
name: "hibernate-orm-rest-data"
languages: [ "java" ]
artifact: "io.quarkus:quarkus-project-core-extension-codestarts"
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package io.quarkus.devtools.codestarts.quarkus;

import static io.quarkus.devtools.codestarts.quarkus.QuarkusCodestartCatalog.Language.JAVA;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.devtools.testing.codestarts.QuarkusCodestartTest;
import io.quarkus.maven.dependency.ArtifactKey;

public class HibernateOrmRestDataCodestartIT {

@RegisterExtension
public static QuarkusCodestartTest codestartTest = QuarkusCodestartTest.builder()
.codestarts("hibernate-orm-rest-data")
.extension(ArtifactKey.ga("io.quarkus", "quarkus-jdbc-h2"))
.extension(ArtifactKey.ga("io.quarkus", "quarkus-resteasy-reactive-jackson"))
.languages(JAVA)
.build();

@Test
void testContent() throws Throwable {
codestartTest.checkGeneratedSource(JAVA, "org.acme.MyEntity");
codestartTest.checkGeneratedSource(JAVA, "org.acme.MyEntityResource");
}

@Test
void testBuild() throws Throwable {
codestartTest.buildAllProjects();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ class QuarkusCodestartBuildIT extends PlatformAwareTestBase {
"spring-web-codestart",
"picocli-codestart",
"hibernate-orm-codestart",
"hibernate-orm-rest-data-codestart",
"reactive-messaging-codestart");

@BeforeAll
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package ilove.quark.us;

import io.quarkus.hibernate.orm.panache.PanacheEntity;
import jakarta.persistence.Entity;


/**
* Example JPA entity defined as a Panache Entity.
* An ID field of Long type is provided, if you want to define your own ID field extends <code>PanacheEntityBase</code> instead.
*
* This uses the active record pattern, you can also use the repository pattern instead:
* .
*
* Usage (more example on the documentation)
*
* {@code
* public void doSomething() {
* MyEntity entity1 = new MyEntity();
* entity1.field = "field-1";
* entity1.persist();
*
* List<MyEntity> entities = MyEntity.listAll();
* }
* }
*/
@Entity
public class MyEntity extends PanacheEntity {
public String field;
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package ilove.quark.us;

import io.quarkus.hibernate.orm.rest.data.panache.PanacheEntityResource;

public interface MyEntityResource extends PanacheEntityResource<MyEntity, Long> {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
-- This file allow to write SQL commands that will be emitted in test and dev.
-- The commands are commented as their support depends of the database
-- insert into myentity (id, field) values(1, 'field-1');
-- insert into myentity (id, field) values(2, 'field-2');
-- insert into myentity (id, field) values(3, 'field-3');
-- alter sequence myentity_seq restart with 4;

0 comments on commit 52e8ad9

Please sign in to comment.