Class XContentTestUtils

java.lang.Object
org.opensearch.test.XContentTestUtils
public final class XContentTestUtils extends Object

  • Method Details

    • convertToMap

      public static Map<String,Object> convertToMap(org.opensearch.core.xcontent.ToXContent part) throws IOException
      Throws:
      IOException

    • convertToXContent

      public static org.opensearch.core.common.bytes.BytesReference convertToXContent(Map<String,?> map, org.opensearch.common.xcontent.XContentType xContentType) throws IOException
      Throws:
      IOException

    • differenceBetweenMapsIgnoringArrayOrder

      public static String differenceBetweenMapsIgnoringArrayOrder(Map<String,Object> first, Map<String,Object> second)
      Compares two maps generated from XContentObjects. The order of elements in arrays is ignored.
      Returns:
      null if maps are equal or path to the element where the difference was found

    • insertRandomFields

      public static org.opensearch.core.common.bytes.BytesReference insertRandomFields(org.opensearch.core.xcontent.MediaType contentType, org.opensearch.core.common.bytes.BytesReference xContent, Predicate<String> excludeFilter, Random random) throws IOException
      This method takes the input xContent data and adds a random field value, inner object or array into each json object. This can e.g. be used to test if parsers that handle the resulting xContent can handle the augmented xContent correctly, for example when testing lenient parsing.

      If the xContent output contains objects that should be skipped of such treatment, an optional filtering Predicate can be supplied that checks xContent paths that should be excluded from this treatment.

      This predicate should check the xContent path that we want to insert to and return true if the path should be excluded. Paths are string concatenating field names and array indices, so e.g. in: 

       {
      "foo1 : {
          "bar" : [
              { ... },
              { ... },
              {
                  "baz" : {
                      // insert here
                  }
              }
          ]
      }
 }
      "foo1.bar.2.baz" would point to the desired insert location.

      To exclude inserting into the "foo1" object we would user a Predicate like 

       
      (path) -> path.endsWith("foo1")
      or if we don't want any random insertions in the "foo1" tree we could use 
       
      (path) -> path.contains("foo1")
      Throws:
      IOException

    • insertIntoXContent

      public static org.opensearch.core.xcontent.XContentBuilder insertIntoXContent(org.opensearch.core.xcontent.XContent xContent, org.opensearch.core.common.bytes.BytesReference original, List<String> paths, Supplier<String> key, Supplier<Object> value) throws IOException
      Inserts key/value pairs into xContent passed in as BytesReference and returns a new XContentBuilder The paths argument uses dot separated fieldnames and numbers for array indices, similar to what we do in ObjectPath. The key/value arguments can suppliers that either return fixed or random values.
      Throws:
      IOException

    • createJsonMapView

      public static XContentTestUtils.JsonMapView createJsonMapView(InputStream inputStream)