nifi-nar-bundles/nifi-mongodb-bundle/nifi-mongodb-processors/src/test/java/org/apache/nifi/processors/mongodb/gridfs/FetchGridFSIT.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.nifi.processors.mongodb.gridfs;

import org.apache.nifi.components.AllowableValue;
import org.apache.nifi.flowfile.attributes.CoreAttributes;
import org.apache.nifi.processors.mongodb.QueryHelper;
import org.apache.nifi.util.MockFlowFile;
import org.apache.nifi.util.TestRunner;
import org.apache.nifi.util.TestRunners;
import org.bson.types.ObjectId;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class FetchGridFSIT extends GridFSITTestBase {
    TestRunner runner;

    static final String BUCKET = "get_test_bucket";

    @BeforeEach
    public void setup() throws Exception {
        runner = TestRunners.newTestRunner(FetchGridFS.class);
        super.setup(runner, BUCKET, false);
    }

    @AfterEach
    public void tearDown() {
        super.tearDown();
    }

    @Test
    public void testGetOneByName() {
        final String fileName = "get_by_name.txt";
        final String content  = "Hello, world";
        ObjectId id = writeTestFile(fileName, content, BUCKET, new HashMap<>());
        Assertions.assertNotNull(id);

        String query = String.format("{\"filename\": \"%s\"}", fileName);
        runner.enqueue(query);
        runner.run();
        runner.assertTransferCount(FetchGridFS.REL_FAILURE, 0);
        runner.assertTransferCount(FetchGridFS.REL_ORIGINAL, 1);
        runner.assertTransferCount(FetchGridFS.REL_SUCCESS, 1);
        List<MockFlowFile> flowFiles = runner.getFlowFilesForRelationship(FetchGridFS.REL_SUCCESS);
        byte[] rawData = runner.getContentAsByteArray(flowFiles.get(0));
        Assertions.assertEquals(new String(rawData), content, "Data did not match for the file");

        runner.clearTransferState();
        runner.setProperty(FetchGridFS.QUERY, query);
        runner.enqueue("test");
        runner.run();

        runner.assertTransferCount(FetchGridFS.REL_FAILURE, 0);
        runner.assertTransferCount(FetchGridFS.REL_ORIGINAL, 1);
        runner.assertTransferCount(FetchGridFS.REL_SUCCESS, 1);
        flowFiles = runner.getFlowFilesForRelationship(FetchGridFS.REL_SUCCESS);
        rawData = runner.getContentAsByteArray(flowFiles.get(0));
        Assertions.assertEquals(new String(rawData), content, "Data did not match for the file");
    }

    @Test
    public void testGetMany() {
        String baseName = "test_file_%d.txt";
        String content  = "Hello, world take %d";
        for (int index = 0; index < 5; index++) {
            ObjectId id = writeTestFile(String.format(baseName, index), String.format(content, index), BUCKET, new HashMap<>());
            Assertions.assertNotNull(id);
        }

        AllowableValue[] values = new AllowableValue[] { QueryHelper.MODE_MANY_COMMITS, QueryHelper.MODE_ONE_COMMIT };

        for (AllowableValue value : values) {
            String query = "{}";
            runner.setProperty(FetchGridFS.OPERATION_MODE, value);
            runner.enqueue(query);
            runner.run();

            runner.assertTransferCount(FetchGridFS.REL_FAILURE, 0);
            runner.assertTransferCount(FetchGridFS.REL_ORIGINAL, 1);
            runner.assertTransferCount(FetchGridFS.REL_SUCCESS, 5);
            runner.clearTransferState();
        }
    }

    @Test
    public void testQueryAttribute() {
        final String fileName = "get_by_name.txt";
        final String content  = "Hello, world";
        ObjectId id = writeTestFile(fileName, content, BUCKET, new HashMap<>());
        Assertions.assertNotNull(id);

        final String queryAttr = "gridfs.query.used";
        final Map<String, String> attrs = new HashMap<>();
        attrs.put(CoreAttributes.FILENAME.key(), fileName);
        runner.setProperty(FetchGridFS.FILE_NAME, String.format("${%s}", CoreAttributes.FILENAME.key()));
        runner.setProperty(FetchGridFS.QUERY_ATTRIBUTE, queryAttr);
        runner.enqueue(content, attrs);
        runner.run();

        runner.assertTransferCount(FetchGridFS.REL_FAILURE, 0);
        runner.assertTransferCount(FetchGridFS.REL_ORIGINAL, 1);
        runner.assertTransferCount(FetchGridFS.REL_SUCCESS, 1);
        MockFlowFile mff = runner.getFlowFilesForRelationship(FetchGridFS.REL_SUCCESS).get(0);
        String attr = mff.getAttribute(queryAttr);
        Assertions.assertNotNull("Query attribute was null.", attr);
        Assertions.assertTrue(attr.contains("filename"), "Wrong content.");

        runner.clearTransferState();

        id = writeTestFile(fileName, content, BUCKET, new HashMap<String, Object>(){{
            put("lookupKey", "xyz");
        }});
        Assertions.assertNotNull(id);

        String query = "{ \"metadata\": { \"lookupKey\": \"xyz\" }}";

        runner.removeProperty(FetchGridFS.FILE_NAME);
        runner.setProperty(FetchGridFS.QUERY, query);
        runner.enqueue(content, attrs);
        runner.run();
        runner.assertTransferCount(FetchGridFS.REL_FAILURE, 0);
        runner.assertTransferCount(FetchGridFS.REL_ORIGINAL, 1);
        runner.assertTransferCount(FetchGridFS.REL_SUCCESS, 1);
        mff = runner.getFlowFilesForRelationship(FetchGridFS.REL_SUCCESS).get(0);
        attr = mff.getAttribute(queryAttr);
        Assertions.assertNotNull("Query attribute was null.", attr);
        Assertions.assertTrue(attr.contains("metadata"), "Wrong content.");
    }

    @Test
    public void testGetQueryFromBody() {
        runner.enqueue("{}");
        testQueryFromSource(0, 1, 1);
    }

    @Test
    public void testGetQueryFromQueryParam() {
        runner.setProperty(FetchGridFS.QUERY, "{}");
        runner.enqueue("");
        testQueryFromSource(0, 1, 1);
    }

    @Test
    public void testGetQueryFromFileNameParam() {
        Map<String, String> attr = new HashMap<>();
        attr.put(CoreAttributes.FILENAME.key(), "get_by_name.txt");
        runner.setProperty(FetchGridFS.FILE_NAME, String.format("${%s}", CoreAttributes.FILENAME.key()));
        runner.enqueue("test", attr);
        testQueryFromSource(0, 1, 1);
    }

    private void testQueryFromSource(int failure, int original, int success) {
        final String fileName = "get_by_name.txt";
        final String content  = "Hello, world";
        ObjectId id = writeTestFile(fileName, content, BUCKET, new HashMap<>());
        Assertions.assertNotNull(id);

        runner.run();
        runner.assertTransferCount(FetchGridFS.REL_FAILURE, failure);
        runner.assertTransferCount(FetchGridFS.REL_ORIGINAL, original);
        runner.assertTransferCount(FetchGridFS.REL_SUCCESS, success);
    }
}