/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.validate.command.internal;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.Collections;

import com.redhat.thermostat.shared.config.OS;
import org.apache.commons.cli.MissingArgumentException;
import org.junit.Before;
import org.junit.Test;

import com.redhat.thermostat.common.cli.Arguments;
import com.redhat.thermostat.common.cli.CommandContext;
import com.redhat.thermostat.common.cli.CommandException;
import com.redhat.thermostat.common.cli.CommandLineArgumentParseException;
import com.redhat.thermostat.common.cli.Console;
import com.redhat.thermostat.plugin.validator.PluginValidator;

public class ValidateCommandTest {
    
    private ValidateCommand cmd;
    private CommandContext ctxt;
    private Arguments mockArgs;
    private Console console;
    private String fileName;
    private ByteArrayOutputStream outputBaos, errorBaos;
    private PrintStream output, error;
        
    @Before
    public void setUp() {
        cmd = new ValidateCommand();
        ctxt = mock(CommandContext.class);
        mockArgs = mock(Arguments.class);
        console = mock(Console.class);

        outputBaos = new ByteArrayOutputStream();
        output = new PrintStream(outputBaos);
        
        errorBaos = new ByteArrayOutputStream();
        error = new PrintStream(errorBaos);
        
        when(ctxt.getArguments()).thenReturn(mockArgs);
        when(ctxt.getConsole()).thenReturn(console);
        when(console.getError()).thenReturn(error);
        when(console.getOutput()).thenReturn(output);
        when(mockArgs.hasArgument("filename")).thenReturn(true);
    }
    
    @Test
    public void validateIncorrectFile() throws CommandException, MissingArgumentException {
        fileName = decodeFilePath(PluginValidator.class.getResource("/incorrectPlugin.xml"));

        when(mockArgs.getNonOptionArguments()).thenReturn(Collections.singletonList(fileName));

        cmd.run(ctxt);
        String errorOutput = new String(errorBaos.toByteArray());
        String validateOutput = buildErrorMessage();

        assertEquals(validateOutput, errorOutput);
        assertEquals("", new String(outputBaos.toByteArray()));
    }

    @Test
    public void validateCorrectFile() throws CommandException, MissingArgumentException {
        fileName = decodeFilePath(PluginValidator.class.getResource("/correctPlugin.xml"));

        when(mockArgs.getNonOptionArguments()).thenReturn(Collections.singletonList(fileName));

        cmd.run(ctxt);
        
        String expected = "Validation successful for file " + fileName + OS.EOL;
        String actual = new String(outputBaos.toByteArray());
        assertEquals(expected, actual);
        
        assertEquals("", new String(errorBaos.toByteArray()));
    }
    
    @Test
    public void validateNonExistingFile() throws CommandException, MissingArgumentException {
        fileName = "/nonExistingFile.xml";
        when(mockArgs.getNonOptionArguments()).thenReturn(Collections.singletonList(fileName));

        try {
            cmd.run(ctxt);    
        } catch(CommandLineArgumentParseException clpae) {
            // pass
        }
    }
    
    @Test
    public void missingFileAsArgument() throws CommandException, MissingArgumentException {
        when(mockArgs.getNonOptionArguments()).thenReturn(Collections.<String>emptyList());
        try {
            cmd.run(ctxt);
            fail();
        } catch(CommandException clpae) {
            // pass
        }
    }
    
    @Test
    public void testStorageRequired() {
        assertFalse(cmd.isStorageRequired());
    }
    
    private String buildErrorMessage() {
        final String LS = OS.EOL;
        final StringBuilder builder = new StringBuilder();
        
        
        builder.append("Error in file ").append(fileName).append(":10.60").append(LS);
        builder.append("cvc-complex-type.2.4.b: The content of element 'bundle' is not complete. One of '{version}' is expected.").append(LS).append(LS);

        builder.append("      <name>test</name>").append(LS);
        builder.append("      <bundles>").append(LS);
        builder.append("        <bundle><symbolic-name>foo</symbolic-name><version>1</version></bundle>").append(LS);
        builder.append("        <bundle><symbolic-name>bar</symbolic-name></bundle>").append(LS);
        builder.append("                                                          ^").append(LS);
        builder.append("Error in file ").append(fileName).append(":11.29").append(LS);
        builder.append("cvc-complex-type.2.3: Element 'bundle' cannot have character [children], because the type's content type is element-only.").append(LS).append(LS);

        builder.append("      <bundles>").append(LS);
        builder.append("        <bundle><symbolic-name>foo</symbolic-name><version>1</version></bundle>").append(LS);
        builder.append("        <bundle><symbolic-name>bar</symbolic-name></bundle>").append(LS);
        builder.append("        <bundle>baz</bundle>").append(LS);
        builder.append("                           ^").append(LS);
        builder.append("Error in file ").append(fileName).append(":11.29").append(LS);
        builder.append("cvc-complex-type.2.4.b: The content of element 'bundle' is not complete. One of '{symbolic-name}' is expected.").append(LS).append(LS);

        builder.append("      <bundles>").append(LS);
        builder.append("        <bundle><symbolic-name>foo</symbolic-name><version>1</version></bundle>").append(LS);
        builder.append("        <bundle><symbolic-name>bar</symbolic-name></bundle>").append(LS);
        builder.append("        <bundle>baz</bundle>").append(LS);
        builder.append("                           ^").append(LS);
        builder.append("Error in file ").append(fileName).append(":13.21").append(LS);
        builder.append("cvc-complex-type.2.4.d: Invalid content was found starting with element 'dependencies'. No child element is expected at this point.").append(LS).append(LS);

        builder.append("        <bundle><symbolic-name>bar</symbolic-name></bundle>").append(LS);
        builder.append("        <bundle>baz</bundle>").append(LS);
        builder.append("      </bundles>").append(LS);
        builder.append("      <dependencies>").append(LS);
        builder.append("                   ^").append(LS).append(LS);
        builder.append("Validation failed for file ").append(fileName).append(LS);

        return builder.toString();
    }

    private static String decodeFilePath(URL url) {
        try {
            // Spaces are encoded as %20 in URLs. Use URLDecoder.decode() so
            // as to handle cases like that.
            final String fn = URLDecoder.decode(url.getFile(), "UTF-8");
            return OS.IS_UNIX ? fn : fn.replace('/','\\').substring(1); // for Windows, ensure backslash, and get rid of leading '/'
        } catch (UnsupportedEncodingException e) {
            throw new AssertionError("UTF-8 not supported, huh?");
        }
    }

}