Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HSEARCH-3667 Envers compatibility #2067

Merged
merged 5 commits into from
Sep 9, 2019
Merged

HSEARCH-3667 Envers compatibility #2067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9639ebd
HSEARCH-3667 handle only persistent classes associated with a pojo.
dcdh Aug 26, 2019
70c3bad
HSEARCH-3667 Create a new module for Envers integration tests
yrodiere Sep 9, 2019
813d155
HSEARCH-3667 Test automatic indexing when Envers is enabled
yrodiere Sep 9, 2019
a3631c3
HSEARCH-3667 Test object loading when Envers is enabled
yrodiere Sep 9, 2019
d9699db
HSEARCH-3667 Run ORM/Envers integration tests when testing different …
yrodiere Sep 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ stage('Non-default environments') {
helper.withMavenWorkspace {
mavenNonDefaultBuild buildEnv, """ \
clean install \
-pl org.hibernate.search:hibernate-search-integrationtest-orm,org.hibernate.search:hibernate-search-integrationtest-showcase-library \
-pl org.hibernate.search:hibernate-search-integrationtest-orm,org.hibernate.search:hibernate-search-integrationtest-mapper-orm-envers,org.hibernate.search:hibernate-search-integrationtest-showcase-library \
-P$buildEnv.mavenProfile \
"""
}
Expand Down
65 changes: 65 additions & 0 deletions integrationtest/mapper/orm-envers/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.hibernate.search</groupId>
<artifactId>hibernate-search-integrationtest</artifactId>
<version>6.0.0-SNAPSHOT</version>
<relativePath>../..</relativePath>
</parent>
<artifactId>hibernate-search-integrationtest-mapper-orm-envers</artifactId>

<name>Hibernate Search Integration Tests - ORM - Envers</name>
<description>Hibernate Search integration tests for the Hibernate ORM integration with Envers</description>

<dependencies>
<dependency>
<groupId>org.hibernate.search</groupId>
<artifactId>hibernate-search-mapper-orm</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-envers</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hibernate.search</groupId>
<artifactId>hibernate-search-util-internal-integrationtest-orm</artifactId>
<scope>test</scope>
</dependency>
<!--
Leave this dependency here, not in a utils module, so that we don't need to recompile
the utils to re-run the tests with a different database.
-->
<dependency>
<groupId>${jdbc.driver.groupId}</groupId>
<artifactId>${jdbc.driver.artifactId}</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<executions>
<execution>
<id>it</id>
<goals>
<goal>integration-test</goal>
<goal>verify</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

</project>

317 changes: 317 additions & 0 deletions ...envers/src/test/java/org/hibernate/search/integrationtest/mapper/orm/envers/EnversIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,317 @@
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.integrationtest.mapper.orm.envers;

import static org.hibernate.search.util.impl.integrationtest.common.stub.backend.StubBackendUtils.reference;

import java.util.Arrays;
import java.util.Optional;
import javax.persistence.Basic;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.OneToOne;

import org.hibernate.SessionFactory;
import org.hibernate.envers.AuditReader;
import org.hibernate.envers.AuditReaderFactory;
import org.hibernate.envers.Audited;
import org.hibernate.envers.query.AuditEntity;
import org.hibernate.search.mapper.orm.Search;
import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
import org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded;
import org.hibernate.search.util.impl.integrationtest.common.rule.BackendMock;
import org.hibernate.search.util.impl.integrationtest.common.rule.StubSearchWorkBehavior;
import org.hibernate.search.util.impl.integrationtest.orm.OrmSetupHelper;
import org.hibernate.search.util.impl.integrationtest.orm.OrmUtils;
import org.hibernate.search.util.impl.test.annotation.PortedFromSearch5;
import org.hibernate.search.util.impl.test.annotation.TestForIssue;
import org.hibernate.search.util.impl.test.rule.StaticCounters;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;

import org.assertj.core.api.SoftAssertions;

@TestForIssue(jiraKey = { "HSEARCH-1293", "HSEARCH-3667" })
@PortedFromSearch5(original = "org.hibernate.search.test.envers.SearchAndEnversIntegrationTest")
public class EnversIT {

@Rule
public BackendMock backendMock = new BackendMock( "stubBackend" );

@Rule
public OrmSetupHelper ormSetupHelper = OrmSetupHelper.withBackendMock( backendMock );

@Rule
public StaticCounters counters = new StaticCounters();

private SessionFactory sessionFactory;

@Before
public void setup() {
backendMock.expectSchema( IndexedEntity.INDEX, b -> b
.field( "text", String.class )
.objectField( "contained", b2 -> b2
.field( "text", String.class )
)
);

sessionFactory = ormSetupHelper.start()
.setup(
IndexedEntity.class,
ContainedEntity.class
);
backendMock.verifyExpectationsMet();
}

@Test
public void test() {
// Initial insert
OrmUtils.withinTransaction( sessionFactory, session -> {
IndexedEntity indexed = new IndexedEntity();
indexed.setId( 1 );
indexed.setText( "initial" );
ContainedEntity contained = new ContainedEntity();
contained.setId( 1 );
contained.setText( "initial" );
indexed.setContained( contained );
contained.setContaining( indexed );

session.persist( indexed );
session.persist( contained );

backendMock.expectWorks( IndexedEntity.INDEX )
.add( "1", b -> b
.field( "text", "initial" )
.objectField( "contained", b2 -> b2
.field( "text", "initial" )
)
)
.preparedThenExecuted();
} );
backendMock.verifyExpectationsMet();
checkEnversAuditedCorrectly( IndexedEntity.class,
1, 1, 1, 1 );
checkEnversAuditedCorrectly( ContainedEntity.class,
1, 1, 1, 1 );
checkSearchLoadedEntityIsLastVersion( "1", "initial", "initial" );

// Update the indexed entity
OrmUtils.withinTransaction( sessionFactory, session -> {
IndexedEntity indexed = session.getReference( IndexedEntity.class, 1 );
indexed.setText( "updated" );

backendMock.expectWorks( IndexedEntity.INDEX )
.update( "1", b -> b
.field( "text", "updated" )
.objectField( "contained", b2 -> b2
.field( "text", "initial" )
)
)
.preparedThenExecuted();
} );
backendMock.verifyExpectationsMet();
checkEnversAuditedCorrectly( IndexedEntity.class,
2, 2, 1, 2 );
checkEnversAuditedCorrectly( ContainedEntity.class,
2, 1, 0, 1 );
checkSearchLoadedEntityIsLastVersion( "1", "updated", "initial" );

// Update the contained entity
OrmUtils.withinTransaction( sessionFactory, session -> {
ContainedEntity contained = session.getReference( ContainedEntity.class, 1 );
contained.setText( "updated" );

backendMock.expectWorks( IndexedEntity.INDEX )
.update( "1", b -> b
.field( "text", "updated" )
.objectField( "contained", b2 -> b2
.field( "text", "updated" )
)
)
.preparedThenExecuted();
} );
backendMock.verifyExpectationsMet();
checkEnversAuditedCorrectly( IndexedEntity.class,
3, 2, 0, 2 );
checkEnversAuditedCorrectly( ContainedEntity.class,
3, 3, 1, 2 );
checkSearchLoadedEntityIsLastVersion( "1", "updated", "updated" );

// Delete the indexed entity
OrmUtils.withinTransaction( sessionFactory, session -> {
IndexedEntity indexed = session.getReference( IndexedEntity.class, 1 );
session.delete( indexed );

backendMock.expectWorks( IndexedEntity.INDEX )
.delete( "1" )
.preparedThenExecuted();
} );
backendMock.verifyExpectationsMet();
checkEnversAuditedCorrectly( IndexedEntity.class,
4, 4, 1, 3 );
checkEnversAuditedCorrectly( ContainedEntity.class,
4, 4, 1, 3 );
}

private void checkEnversAuditedCorrectly(Class<?> type,
int lastRevisionOverall,
int expectedLastRevisionForType,
int expectedEntityChangeCountAtLastRevisionOverall,
int expectedAuditedObjectCountSoFar) {
OrmUtils.withinTransaction( sessionFactory, session -> {
AuditReader auditReader = AuditReaderFactory.get( session );
SoftAssertions.assertSoftly( assertions -> {
assertions.assertThat( findLastRevisionForEntity( auditReader, type ) )
.as( "Last revision for entity type " + type )
.isEqualTo( expectedLastRevisionForType );
assertions.assertThat( howManyEntitiesChangedAtRevisionNumber( auditReader, type, lastRevisionOverall ) )
.as( "Number of entity changed at revision " + lastRevisionOverall + " for entity type " + type )
.isEqualTo( expectedEntityChangeCountAtLastRevisionOverall );
assertions.assertThat( howManyAuditedObjectsSoFar( auditReader, type ) )
.as( "Number of audited objects so far for entity type " + type )
.isEqualTo( expectedAuditedObjectCountSoFar );
} );
} );
}

private void checkSearchLoadedEntityIsLastVersion(String id,
String expectedIndexedEntityText, String expectedContainedEntityText) {
OrmUtils.withinTransaction( sessionFactory, session -> {
backendMock.expectSearchObjects(
Arrays.asList( IndexedEntity.INDEX ),
b -> b.limit( 2 ), // fetchSingleHit() (see below) sets the limit to 2 to check if there really is a single hit
StubSearchWorkBehavior.of(
1L,
reference( IndexedEntity.INDEX, id )
)
);
Optional<IndexedEntity> loadedEntity = Search.session( session ).search( IndexedEntity.class )
.predicate( f -> f.matchAll() )
.fetchSingleHit();
SoftAssertions.assertSoftly( assertions -> {
assertions.assertThat( loadedEntity ).get()
.as( "getText()" )
.extracting( IndexedEntity::getText )
.isEqualTo( expectedIndexedEntityText );
assertions.assertThat( loadedEntity ).get()
.as( "getContained().getText()" )
.extracting( e -> e.getContained().getText() )
.isEqualTo( expectedContainedEntityText );
} );
} );
}

/**
* It returns how many entities are modified for a specific class and number revision.
*/
private int howManyEntitiesChangedAtRevisionNumber(AuditReader auditReader, Class<?> clazz, Number revision) {
return ( (Long) auditReader.createQuery().forEntitiesModifiedAtRevision( clazz, revision )
.addProjection( AuditEntity.id().count() ).getSingleResult() ).intValue();
}

/**
* It returns how many audited objects are there globally for a specific class.
*/
private int howManyAuditedObjectsSoFar(AuditReader auditReader, Class<?> clazz) {
return auditReader.createQuery().forRevisionsOfEntity( clazz, true, true ).getResultList().size();
}

/**
* It returns the last revision for a specific class.
*/
private Number findLastRevisionForEntity(AuditReader auditReader, Class<?> clazz) {
return (Number) auditReader.createQuery().forRevisionsOfEntity( clazz, false, true )
.addProjection( AuditEntity.revisionNumber().max() ).getSingleResult();
}

@Entity(name = "indexed")
@Indexed(index = IndexedEntity.INDEX)
@Audited(withModifiedFlag = true)
public static final class IndexedEntity {

static final String INDEX = "IndexedEntity";

@Id
private Integer id;

@Basic
@GenericField
private String text;

@OneToOne
@IndexedEmbedded
private ContainedEntity contained;

public Integer getId() {
return id;
}

public void setId(Integer id) {
this.id = id;
}

public String getText() {
return text;
}

public void setText(String text) {
this.text = text;
}

public ContainedEntity getContained() {
return contained;
}

public void setContained(
ContainedEntity contained) {
this.contained = contained;
}
}

@Entity(name = "idxembedded")
@Audited(withModifiedFlag = true)
public static class ContainedEntity {

@Id
private Integer id;

@Basic
@GenericField
private String text;

@OneToOne(mappedBy = "contained")
private IndexedEntity containing;

public Integer getId() {
return id;
}

public void setId(Integer id) {
this.id = id;
}

public String getText() {
return text;
}

public void setText(String text) {
this.text = text;
}

public IndexedEntity getContaining() {
return containing;
}

public void setContaining(IndexedEntity containing) {
this.containing = containing;
}
}

}
Loading