/*
    * 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
    *
   *   https://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.commons.exec;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  
  import java.io.File;
  import java.io.OutputStream;
  import java.nio.charset.Charset;
  import java.nio.charset.StandardCharsets;
  import java.nio.file.Path;
  
  import org.junit.jupiter.api.AfterEach;
  import org.junit.jupiter.api.Disabled;
  import org.junit.jupiter.api.Test;
  import org.junitpioneer.jupiter.SetSystemProperty;
  
  /**
   * Test the LogOutputStream.
   */
  // turn on debug mode and throw an exception for each encountered problem
  @SetSystemProperty(key = "org.apache.commons.exec.lenient", value = "false")
  @SetSystemProperty(key = "org.apache.commons.exec.debug", value = "true")
  class LogOutputStreamTest {
  
      private static final class TestLogOutputStream extends LogOutputStream {
  
          private final StringBuffer output = new StringBuffer();
  
          private TestLogOutputStream(final int level) {
              super(level);
          }
  
          private TestLogOutputStream(final int level, final Charset charset) {
              super(level, charset);
          }
  
          private String getOutput() {
              return output.toString();
          }
  
          @Override
          protected void processLine(final String line, final int level) {
              output.append(line);
          }
      }
  
      private final Executor exec = DefaultExecutor.builder().get();
      private final File testDir = new File("src/test/scripts");
      private OutputStream systemOut;
      private final Path environmentScript = TestUtil.resolveScriptPathForOS(testDir + "/environment");
      private final Path utf8CharacterScript = TestUtil.resolveScriptPathForOS(testDir + "/utf8Characters");
  
      @AfterEach
      public void tearDown() throws Exception {
          if (this.systemOut != null) {
              this.systemOut.close();
          }
      }
  
      @Test
      void testStdout() throws Exception {
          this.systemOut = new TestLogOutputStream(1);
          this.exec.setStreamHandler(new PumpStreamHandler(systemOut, systemOut));
          final CommandLine cl = new CommandLine(environmentScript);
          final int exitValue = exec.execute(cl);
          assertFalse(exec.isFailure(exitValue));
      }
  
      @Test
      @Disabled("The file utf8CharacterScript is missing from the repository and is not in its history")
      void testStdoutWithUTF8Characters() throws Exception {
          this.systemOut = new TestLogOutputStream(1, StandardCharsets.UTF_8);
          this.exec.setStreamHandler(new PumpStreamHandler(systemOut, systemOut));
          final CommandLine cl = new CommandLine(utf8CharacterScript);
          final int exitValue = exec.execute(cl);
          assertFalse(exec.isFailure(exitValue));
          assertEquals("This string contains UTF-8 characters like the see no evil monkey \uD83D\uDE48 and the right single quotation mark \u2019",
                  ((TestLogOutputStream) systemOut).getOutput());
      }
  
  }