Package org.mongounit

Annotation Interface SeedWithDataset

@Retention(RUNTIME) @Target({TYPE,METHOD}) @Repeatable(SeedWithDatasets.class) public @interface SeedWithDataset
SeedWithDataset annotation specifies location(s) of a JSON-based file(s) with data to seed the database before a target test is executed. It can be used on a class, on a method, or in combination of the two which would have a cumulative effect, i.e., the data pointed to by the method annotation would be added to the data pointed to by the class annotation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    locations
    List of locations of JSON files that contain the dataset to seed the database with.
    LocationType
    locationType
     
    boolean
    reuseForAssertion
    Returns whether or not the dataset(s) of this annotation should also be used when building up the dataset(s) with which to assert.
    String[]
    value
    List of locations of JSON files that contain the dataset to seed the database with.

  • Element Details

    • value

      @AliasFor("locations") String[] value
      List of locations of JSON files that contain the dataset to seed the database with. Specifying this annotation on a class or a method without providing at least a single location should cause the MongoUnit framework to look for a default file named 'ClassName-seed.json' or 'methodName-seed.json' (depending on the location of the annotation). The directory in which this file will be looked for depends on the provided 'locationType'. If 'locationType' is 'CLASSPATH_ROOT', the file will be looked for at the classpath root. If the 'locationType' is 'CLASS', the file will be looked for at theclasspath root plus the package structure along with class name (or 'name' specified by MongoUnitTest), i.e., if the fully qualified name of the test class is 'com.mytest.MyIT' and this value is selected, the file will be searched for in the '/com/mytest/MyIT' folder relative to the root of the classpath. If 'com.mytest.MyIT' class' MongoUnitTest annotation specifies 'name' of 'test1', the file will be searched for in the '/com/mytest/test1' folder relative to the root of the classpath. If the 'locationType' is 'ABSOLUTE', the file will be looked for in the root directory, i.e ., '/'. If the MongoUnit framework fails to find any of the the seed data file(s), an exception will be thrown. If the desired initial/seeded state is an empty database, omit this annotation altogether. Multiple locations have a cumulative seeding effect, i.e., the data is seeded into the database sequentially and is combined in the order specified in the 'locations' array before a test method is executed.
      Returns:
      List of locations of JSON files that contain the dataset to seed the database with.
      Default:
      {}

    • locations

      @AliasFor("value") String[] locations
      List of locations of JSON files that contain the dataset to seed the database with. Specifying this annotation on a class or a method without providing at least a single location should cause the MongoUnit framework to look for a default file named 'ClassName-seed.json' or 'methodName-seed.json' (depending on the location of the annotation). The directory in which this file will be looked for depends on the provided 'locationType'. If 'locationType' is 'CLASSPATH_ROOT', the file will be looked for at the classpath root. If the 'locationType' is 'CLASS', the file will be looked for at theclasspath root plus the package structure along with class name (or 'name' specified by MongoUnitTest), i.e., if the fully qualified name of the test class is 'com.mytest.MyIT' and this value is selected, the file will be searched for in the '/com/mytest/MyIT' folder relative to the root of the classpath. If 'com.mytest.MyIT' class' MongoUnitTest annotation specifies 'name' of 'test1', the file will be searched for in the '/com/mytest/test1' folder relative to the root of the classpath. If the 'locationType' is 'ABSOLUTE', the file will be looked for in the root directory, i.e ., '/'. If the MongoUnit framework fails to find any of the the seed data file(s), an exception will be thrown. If the desired initial/seeded state is an empty database, omit this annotation altogether. Multiple locations have a cumulative seeding effect, i.e., the data is seeded into the database sequentially and is combined in the order specified in the 'locations' array before a test method is executed.
      Returns:
      List of locations of JSON files that contain the dataset to seed the database with.
      Default:
      {}

    • locationType

      LocationType locationType
      Returns:
      Dictates how to treat paths specified in 'locations' or its alias 'value'.
      Default:
      CLASS

    • reuseForAssertion

      boolean reuseForAssertion
      Returns whether or not the dataset(s) of this annotation should also be used when building up the dataset(s) with which to assert.
      Returns:
      Whether or not the dataset(s) of this annotation should also be used when building up the dataset(s) with which to assert.

      For example, if a dataset is not supposed to be altered in any way, this flag can be used so there is no need for a different JSON file or a separate AssertMatchesDataset annotation containing the exact same data to be loaded again.

      Another example would be if a dataset is simply used as a supporting dataset to the dataset that's actually not going to change as a result of some target test method call. The supporting dataset should not change and can be reused to assertion.

      NOTE: If the assertion is simply verifying that nothing changed after the execution of the target test method, such AssertMatchesDataset annotation should use the 'additionalDataset = false'. See JavaDoc for AssertMatchesDataset.

      Default:
      false