ArgumentsJsonProviderTest.java

/**
 * Licensed 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 net.logstash.logback.composite.loggingevent;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.when;

import java.io.IOException;
import java.io.StringWriter;
import java.util.LinkedHashMap;
import java.util.Map;

import net.logstash.logback.argument.StructuredArguments;
import net.logstash.logback.fieldnames.LogstashFieldNames;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;

import ch.qos.logback.classic.spi.ILoggingEvent;

import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.MappingJsonFactory;


public class ArgumentsJsonProviderTest {


    @Rule
    public MockitoRule rule = MockitoJUnit.rule();

    private ArgumentsJsonProvider provider = new ArgumentsJsonProvider();

    private JsonFactory factory = new MappingJsonFactory();

    private StringWriter writer = new StringWriter();

    private JsonGenerator generator;

    @Mock
    private ILoggingEvent event;

    private Object[] arguments;
    
    private static class Foo {
        private String k6 = "v6";
        
        public String getK6() {
            return k6;
        }
    }

    @Before
    public void setup() throws IOException {
        
        generator = factory.createGenerator(writer);
        
        Map<String, String> map = new LinkedHashMap<String, String>();
        map.put("k4", "v4");
        map.put("k5", "v5");
        arguments = new Object[] {
                StructuredArguments.keyValue("k0", "v0"),
                StructuredArguments.keyValue("k1", "v1", "{0}=[{1}]"),
                StructuredArguments.value("k2", "v2"),
                StructuredArguments.array("k3", "v3a", "v3b"),
                StructuredArguments.entries(map),
                StructuredArguments.fields(new Foo()),
                StructuredArguments.raw("k7", "\"v7\""),
                "v8",
        };
        when(event.getArgumentArray()).thenReturn(arguments);
    }

    @Test
    public void testUnwrapped() throws IOException {
        generator.writeStartObject();
        provider.writeTo(generator, event);
        generator.writeEndObject();
        
        generator.flush();
        
        assertThat(writer.toString()).isEqualTo(
                "{"
                        + "\"k0\":\"v0\","
                        + "\"k1\":\"v1\","
                        + "\"k2\":\"v2\","
                        + "\"k3\":[\"v3a\",\"v3b\"],"
                        + "\"k4\":\"v4\","
                        + "\"k5\":\"v5\","
                        + "\"k6\":\"v6\","
                        + "\"k7\":\"v7\""
                + "}");
    }

    @Test
    public void testWrapped() throws IOException {
        provider.setFieldName("args");

        generator.writeStartObject();
        provider.writeTo(generator, event);
        generator.writeEndObject();
        
        generator.flush();
        
        assertThat(writer.toString()).isEqualTo(
                "{"
                    + "\"args\":{"
                        + "\"k0\":\"v0\","
                        + "\"k1\":\"v1\","
                        + "\"k2\":\"v2\","
                        + "\"k3\":[\"v3a\",\"v3b\"],"
                        + "\"k4\":\"v4\","
                        + "\"k5\":\"v5\","
                        + "\"k6\":\"v6\","
                        + "\"k7\":\"v7\""
                    + "}"
                + "}");
    }


    @Test
    public void testIncludeNonStructuredArguments() throws IOException {
        provider.setIncludeNonStructuredArguments(true);

        generator.writeStartObject();
        provider.writeTo(generator, event);
        generator.writeEndObject();
        
        generator.flush();
        
        assertThat(writer.toString()).isEqualTo(
                "{"
                        + "\"k0\":\"v0\","
                        + "\"k1\":\"v1\","
                        + "\"k2\":\"v2\","
                        + "\"k3\":[\"v3a\",\"v3b\"],"
                        + "\"k4\":\"v4\","
                        + "\"k5\":\"v5\","
                        + "\"k6\":\"v6\","
                        + "\"k7\":\"v7\","
                        + "\"arg7\":\"v8\""
                + "}");
    }

    @Test
    public void testIncludeNonStructuredArgumentsAndCustomPrefix() throws IOException {
        provider.setIncludeNonStructuredArguments(true);
        provider.setNonStructuredArgumentsFieldPrefix("prefix");

        generator.writeStartObject();
        provider.writeTo(generator, event);
        generator.writeEndObject();
        
        generator.flush();
        
        assertThat(writer.toString()).isEqualTo(
                "{"
                        + "\"k0\":\"v0\","
                        + "\"k1\":\"v1\","
                        + "\"k2\":\"v2\","
                        + "\"k3\":[\"v3a\",\"v3b\"],"
                        + "\"k4\":\"v4\","
                        + "\"k5\":\"v5\","
                        + "\"k6\":\"v6\","
                        + "\"k7\":\"v7\","
                        + "\"prefix7\":\"v8\""
                + "}");
    }

}