[TEST] [LTS-2023] missing directories when testing with local contribution

cheshire

hello, i need to test operations and listeners using vocabularies, they are present in my studio package but, from what i understand are not included when the package is deployed locally  upon testing

• this error when running a test meant to use a local directory contribution

%ERROR  1,should_Pass(my.package.operations.SomeOperationTest)
%TRACES 
org.nuxeo.ecm.directory.DirectoryException: Failed to invoke operation SomeOperation, No directory registered with name: Some_Directory

• below is the structure of my core project source folder

main
  |- java
  |   |- my.package.operations
  |   |   |- SomeOperation.java
test
  |- java
  |   |- my.package.operations
  |   |   |- SomeOperationTest.java
  |- resources
  |   |- directories
  |   |   |- Some_Directory.csv
  |   |- OSGI-INF
  |   |   |- test-directories-contrib.xml

• here is my test class

@RunWith(FeaturesRunner.class)
@Features(AutomationFeature.class)
@RepositoryConfig(cleanup = Granularity.METHOD)
@Deploy({
    "studio.extensions.my-studio",
    "my-bundle-symbolic-name",
    "my-bundle-symbolic-name:OSGI-INF/test-directories-contrib.xml"})
public class SomeOperationTest {

  @Inject
  OperationContext context;

  @Inject
  AutomationService automation;
  
  public void should_Pass() throws OperationException {

    automation.run(context, "SomeOperation"); // raises exception

    // ... some assertion
  }
}

• here is the operation failing

@Operation(
    id = "SomeOperation",
    category = "Some",
    label = "Operation",
    description = "Openning a directory")
public class SomeOperation {

  @OperationMethod()
  public void run() {

    Framework.getService(DirectoryService.class).open("Some_Directory"); // raises exception

    // ... some more code
  }
}

• this is the contribution

<?xml version="1.0"?>
<component name="my.package.test.directories">
  <extension target="org.nuxeo.ecm.directory.GenericDirectory" point="directories">
    <directory name="Some_Directory" extends="template-directory">
      <schema>vocabulary</schema>
      <idField>id</idField>
      <autoincrementIdField>false</autoincrementIdField>
      <dataFile>directories/Some_Directory.csv</dataFile>
      <createTablePolicy>on_missing_columns</createTablePolicy>
    </directory>
  </extension>
</component>

• this is the content of the csv file

id,label,obsolete
"some","entry","0"

what am i missing, i have been running in circle for quite some time now i can't seem to find a solution anywhere

Jordann_Rousse1

As you can see, your studio contribution is not loaded due to missing references, which should explain why your vocabulary is not defined during the context of your unit test:

  * service:studio.extensions.autodistribution references missing [target=org.nuxeo.elasticsearch.ElasticSearchComponent;point=elasticSearchIndex, target=org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService;point=loginScreen, target=org.nuxeo.ecm.platform.WebResources;point=resources, target=org.nuxeo.ecm.platform.WebResources;point=bundles, target=org.nuxeo.ecm.platform.types.TypeService;point=types, target=org.nuxeo.ecm.platform.ec.notification.service.NotificationService;point=templates]

For each missing reference, you need to find which bundle brings it, and you should deploy it within your unit test.
For example with point=elasticSearchIndex, we can see the extension point is defined there: https://github.com/nuxeo/nuxeo/blob/1b35dcdbce963594a6d891e7ccdf0c9279ad4fce/modules/platform/nuxeo-elasticsearch/nuxeo-elasticsearch-core/src/main/resources/OSGI-INF/elasticsearch-service.xml#L44 

Which is part of bundle "org.nuxeo.elasticsearch.core" (see here https://github.com/nuxeo/nuxeo/blob/1b35dcdbce963594a6d891e7ccdf0c9279ad4fce/modules/platform/nuxeo-elasticsearch/nuxeo-elasticsearch-core/src/main/resources/META-INF/MANIFEST.**** )

So either you deploy "org.nuxeo.elasticsearch.core", or you can directly use feature "RepositoryElasticSearchFeature" already loading that bundle:  https://github.com/nuxeo/nuxeo/blob/1b35dcdbce963594a6d891e7ccdf0c9279ad4fce/modules/platform/nuxeo-elasticsearch/nuxeo-elasticsearch-core/src/test/java/org/nuxeo/elasticsearch/test/RepositoryElasticSearchFeature.java 

 

Repeat that logic for each missing references until your service:studio.extensions.autodistribution is loaded when you execute your test! 🙂