ME-38:Added billing module domains by sudhanshu-raj · Pull Request #41 · openmrs/openmrs-module-metadataexport

sudhanshu-raj · 2026-09-09T15:31:50Z

Description of what I changed

Added billing module domains

Issue I worked on

see https://openmrs.atlassian.net/browse/ME-38

Checklist: I completed these to help reviewers :)

My IDE is configured to follow the code style of this project.

No? Unsure? -> configure your IDE, format the code and add the changes with git add . && git commit --amend
I have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)

No? -> write tests and add them to this commit git add . && git commit --amend
I ran mvn clean package right before creating this pull request and
added all formatting changes to my commit.

No? -> execute above command
All new and existing tests passed.

No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
My pull request is based on the latest changes of the master branch.

No? Unsure? -> execute command git pull --rebase upstream master

sudhanshu-raj · 2026-09-09T15:34:22Z

hi @wikumChamith let me know if this is what expected from billing module domains , and i will test cases, configs and readme update

wikumChamith · 2026-09-10T02:00:56Z

@sudhanshu-raj have you noticed the build errors?

Bawanthathilan · 2026-09-10T06:16:32Z

@sudhanshu-raj can you check these build errors ?

sudhanshu-raj · 2026-09-13T19:41:53Z

Hey @wikumChamith , though I fixed the exact error which happening due to event api which needed for billing module.

But there is different issue which stopping the build and that is I think infinite recursive loop for the beans . The thing is its something wrong(which I assuming) with the how the beans are loading from the moduleApplicationContext.xml in the billing module because when I build with skipping the test it got build success but with including the test and the test classpath as we know BaseModuleContextSensitiveTest loads the all beans from the context and that part triggers the loop . I'm not sure exactly which things is causing the loop, though I tried some fixes in billing module which I though could help but it didn't . I'm dumping logs which could understand better, here is build logs that got stuck and here is the surefire test execution process logs.

wikumChamith · 2026-09-14T09:26:00Z

@sudhanshu-raj what if we keep the jars for compilation but keep them out of the test JVM?

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <classpathDependencyExcludes>
            <classpathDependencyExclude>org.openmrs.module:billing-api</classpathDependencyExclude>
            <classpathDependencyExclude>org.openmrs.module:stockmanagement-api</classpathDependencyExclude>
        </classpathDependencyExcludes>
    </configuration>
</plugin>

sudhanshu-raj · 2026-09-14T09:56:58Z

@sudhanshu-raj what if we keep the jars for compilation but keep them out of the test JVM?

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <classpathDependencyExcludes>
            <classpathDependencyExclude>org.openmrs.module:billing-api</classpathDependencyExclude>
            <classpathDependencyExclude>org.openmrs.module:stockmanagement-api</classpathDependencyExclude>
        </classpathDependencyExcludes>
    </configuration>
</plugin>

Will that not cause for the integration tests or calling the billing services methods, because those jar will be removed during the test classpath ?

wikumChamith · 2026-09-14T10:20:26Z

@sudhanshu-raj what if we keep the jars for compilation but keep them out of the test JVM?
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <classpathDependencyExcludes>
            <classpathDependencyExclude>org.openmrs.module:billing-api</classpathDependencyExclude>
            <classpathDependencyExclude>org.openmrs.module:stockmanagement-api</classpathDependencyExclude>
        </classpathDependencyExcludes>
    </configuration>
</plugin>
Will that not cause for the integration tests or calling the billing services methods, because those jar will be removed during the test classpath ?

Ohh yes. Let's keep the exclusion on the default Surefire execution but give the billing tests their own execution with the full classpath

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <executions>
        <execution>
            <id>default-test</id>
            <configuration>
                <excludes>
                    <exclude>**/domain/billing/**</exclude>
                </excludes>
                <classpathDependencyExcludes>
                    <classpathDependencyExclude>org.openmrs.module:billing-api</classpathDependencyExclude>
                    <classpathDependencyExclude>org.openmrs.module:stockmanagement-api</classpathDependencyExclude>
                </classpathDependencyExcludes>
            </configuration>
        </execution>
        <execution>
            <id>billing-unit-tests</id>
            <goals><goal>test</goal></goals>
            <configuration>
                <includes>
                    <include>**/domain/billing/**/*Test.java</include>
                </includes>
            </configuration>
        </execution>
    </executions>
</plugin>

sudhanshu-raj · 2026-09-14T19:36:37Z

ok, tested with one integration test for BillableServiceDomainExporter , seems like this test case got hung again and caught in same loop.

wikumChamith · 2026-09-15T12:43:53Z

@sudhanshu-raj so I looked into this, and to fix it we need to make a few changes. I'll go through them one by one.

Billing's exemption evaluator needs GraalVM, which the platform supplies from 2.8.2 onward. So we should bump the platform version to 2.8.3.
Then we'll need to bump stockmanagementVersion from 1.4.0 to 3.0.0. This is because older stockmanagement releases reference LuceneQuery, which was removed from core in 2.8.0.
Then we need to add a sessionFactory override in TestingApplicationContext.xml plus a new test-hibernate.cfg.xml. Billing maps BillableService, CashPoint, PaymentMode and others in hbm files that only the running billing module registers. Without this, the integration test fails with "Unknown entity". Check the initializer module for an example.

<bean id="sessionFactory" class="org.openmrs.api.db.hibernate.HibernateSessionFactoryBean">
	<property name="configLocations">
		<list>
			<value>classpath:hibernate.cfg.xml</value>
			<value>classpath:test-hibernate.cfg.xml</value>
		</list>
	</property>
	<property name="mappingJarLocations" ref="mappingJarResources"/>
	<property name="packagesToScan">
		<list>
			<value>org.openmrs</value>
		</list>
	</property>
</bean>

test-hibernate.cfg.xml:

<hibernate-configuration>
    <session-factory>
        <!-- Billing -->
        <mapping resource="Bill.hbm.xml"/>
        <mapping resource="Cashier.hbm.xml"/>
        <mapping resource="SequentialReceiptNumberGenerator.hbm.xml"/>
    </session-factory>
</hibernate-configuration>

sudhanshu-raj · 2026-09-15T22:17:24Z

@sudhanshu-raj so I looked into this, and to fix it we need to make a few changes. I'll go through them one by one.

Billing's exemption evaluator needs GraalVM, which the platform supplies from 2.8.2 onward. So we should bump the platform version to 2.8.3.

Then we'll need to bump stockmanagementVersion from 1.4.0 to 3.0.0. This is because older stockmanagement releases reference LuceneQuery, which was removed from core in 2.8.0.

Then we need to add a sessionFactory override in TestingApplicationContext.xml plus a new test-hibernate.cfg.xml. Billing maps BillableService, CashPoint, PaymentMode and others in hbm files that only the running billing module registers. Without this, the integration test fails with "Unknown entity". Check the initializer module for an example.
<bean id="sessionFactory" class="org.openmrs.api.db.hibernate.HibernateSessionFactoryBean">
	<property name="configLocations">
		<list>
			<value>classpath:hibernate.cfg.xml</value>
			<value>classpath:test-hibernate.cfg.xml</value>
		</list>
	</property>
	<property name="mappingJarLocations" ref="mappingJarResources"/>
	<property name="packagesToScan">
		<list>
			<value>org.openmrs</value>
		</list>
	</property>
</bean>
test-hibernate.cfg.xml:
<hibernate-configuration>
    <session-factory>
        
        <mapping resource="Bill.hbm.xml"/>
        <mapping resource="Cashier.hbm.xml"/>
        <mapping resource="SequentialReceiptNumberGenerator.hbm.xml"/>
    </session-factory>
</hibernate-configuration>

It worked, thanks

sudhanshu-raj · 2026-09-15T22:33:17Z

And I am curious how you came up with this ?

wikumChamith · 2026-09-16T13:54:17Z

And I am curious how you came up with this ?

Just went through it one error at a time. Had some help from Claude too.

wikumChamith · 2026-09-16T15:02:11Z

@sudhanshu-raj let's resolve these merge conflicts and make this ready for review.

sudhanshu-raj · 2026-09-16T20:33:20Z

Ok so merged the conflicts and the new changes, then created test cases for BillableService domain , and while testing this I realized build got hung on same loop after merging the new changes because when I build after applying loop fix which is after this commit ME-38:Upgraded platform version and added configs 2211ed71ed978b3e1038cba9b2bc0599b7cc7e5a build got success.

wikumChamith · 2026-09-17T04:57:40Z

@sudhanshu-raj have you tested this by trying to load the billing configs created by it using the initializer? The way to do it is to spin up a fresh OpenMRS O3 server and replace the billing configuration there with the exported one.

sudhanshu-raj · 2026-09-17T13:58:38Z

@sudhanshu-raj have you tested this by trying to load the billing configs created by it using the initializer? The way to do it is to spin up a fresh OpenMRS O3 server and replace the billing configuration there with the exported one.

Yes I tried loading all exported billing domain configs and matched it;s format too, it seems to worked after some small fixes. Yeah but i need to build without tests due to loop issue.

wikumChamith · 2026-09-17T15:13:19Z

Let's drop or disable the breaking tests for now if they're giving too much trouble.

sudhanshu-raj · 2026-09-17T21:29:10Z

Let's drop or disable the breaking tests for now if they're giving too much trouble.

Ready for the review !

wikumChamith · 2026-09-18T02:12:49Z

+		if (instance.getServiceType() != null) {
+			Concept serviceType = instance.getServiceType();
+			String serviceTypeName = null;
+			if (serviceType.getNames() != null && !serviceType.getNames().isEmpty()) {
+				serviceTypeName = serviceType.getNames().iterator().next().getName();
+			}
+			line.put(HEADER_SERVICE_TYPE, serviceTypeName);
+		}


Rather than exporting service type as an arbitrary concept name, we can just export the UUID. In the BillableServicesLineProcessor, this field is resolved with Utils.fetchConcept, which supports UUIDs.

# Conflicts: # pom.xml # Conflicts: # pom.xml # Conflicts: # pom.xml # Conflicts: # pom.xml # Conflicts: # pom.xml

# Conflicts: # omod/src/main/resources/config.xml

sudhanshu-raj mentioned this pull request Sep 16, 2026

Upgrade module to 2.8.3 openmrs/openmrs-module-billing#194

Open

sudhanshu-raj force-pushed the ME-38 branch from 0a40d24 to 945390c Compare September 16, 2026 20:24

sudhanshu-raj force-pushed the ME-38 branch from 945390c to 11962cb Compare September 17, 2026 21:09

sudhanshu-raj marked this pull request as ready for review September 17, 2026 21:10

wikumChamith reviewed Sep 18, 2026

View reviewed changes

wikumChamith requested review from dkayiwa and ibacher September 18, 2026 02:24

sudhanshu-raj added 5 commits September 18, 2026 13:50

ME-38:Added billing module domains

c742013

# Conflicts: # pom.xml # Conflicts: # pom.xml # Conflicts: # pom.xml # Conflicts: # pom.xml # Conflicts: # pom.xml

ME-38:Added even-api dependency for billing module test path

1a050d8

# Conflicts: # omod/src/main/resources/config.xml

ME-38: BillableServiceDomainExport integration test case

f0e7c22

ME-38:Upgraded platform version and added configs

2b1431d

Added test cases for BillableService domain

e9bbe42

sudhanshu-raj added 3 commits September 18, 2026 13:53

ME-38: Added null checks and serviceTypeName update

25cd31d

ME-38:Added test cases for rest billing domains

f7d68b1

ME-38:Back to serviceType uuid and readme update

5fe53e4

sudhanshu-raj force-pushed the ME-38 branch from 2ef3e7a to 5fe53e4 Compare September 18, 2026 08:25

sudhanshu-raj requested a review from wikumChamith September 18, 2026 08:26

Conversation

sudhanshu-raj commented Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of what I changed

Issue I worked on

Checklist: I completed these to help reviewers :)

Uh oh!

sudhanshu-raj commented Sep 9, 2026

Uh oh!

wikumChamith commented Sep 10, 2026

Uh oh!

Bawanthathilan commented Sep 10, 2026

Uh oh!

sudhanshu-raj commented Sep 13, 2026

Uh oh!

wikumChamith commented Sep 14, 2026

Uh oh!

sudhanshu-raj commented Sep 14, 2026

Uh oh!

wikumChamith commented Sep 14, 2026

Uh oh!

sudhanshu-raj commented Sep 14, 2026

Uh oh!

wikumChamith commented Sep 15, 2026

Uh oh!

sudhanshu-raj commented Sep 15, 2026

Uh oh!

sudhanshu-raj commented Sep 15, 2026

Uh oh!

wikumChamith commented Sep 16, 2026

Uh oh!

wikumChamith commented Sep 16, 2026

Uh oh!

sudhanshu-raj commented Sep 16, 2026

Uh oh!

wikumChamith commented Sep 17, 2026

Uh oh!

sudhanshu-raj commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wikumChamith commented Sep 17, 2026

Uh oh!

sudhanshu-raj commented Sep 17, 2026

Uh oh!

wikumChamith Sep 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sudhanshu-raj commented Sep 9, 2026 •

edited

Loading

sudhanshu-raj commented Sep 17, 2026 •

edited

Loading