package org.apache.maven.surefire.report;
   
   /*
    * 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.
   */
  
  import java.io.BufferedOutputStream;
  import java.io.OutputStreamWriter;
  import java.io.PrintStream;
  import java.io.PrintWriter;
  
  /**
   * Base class for console reporters.
   *
   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
   */
  public abstract class AbstractConsoleReporter
      extends AbstractTextReporter
      implements RunReporter
  {
      private static final String TEST_SET_STARTING_PREFIX = "Running ";
  
      private static final String TEST_SET_STARTING_GROUP_PREFIX = " (of ";
  
      private static final String TEST_SET_STARTING_GROUP_SUFIX = ")";
  
      private static final int BUFFER_SIZE = 4096;
  
      private static final PrintStream ORIGINAL_SYSTEM_OUT = System.out;
  
      AbstractConsoleReporter( String format, ReporterConfiguration reporterConfiguration )
      {
          // TODO: use logger
          super(
              new PrintWriter( new OutputStreamWriter( new BufferedOutputStream( ORIGINAL_SYSTEM_OUT, BUFFER_SIZE ) ) ),
              format, reporterConfiguration );
      }
  
      public void testSetStarting( ReportEntry report )
          throws ReporterException
      {
          super.testSetStarting( report );
  
          writeMessage( getTestSetStartingMessage( report ) );
      }
  
      public void runStarting()
      {
          writeHeading( "" );
          writeHeading( "-------------------------------------------------------" );
          writeHeading( " T E S T S" );
          writeHeading( "-------------------------------------------------------" );
      }
  
      void writeHeading( String message )
      {
          writer.println( message );
          writer.flush();
      }
  
      /**
       * Get the test set starting message for a report.
       * eg. "Running org.foo.BarTest ( of group )"
       *
       * @param report report whose test set is starting
       * @return the message
       */
      public static String getTestSetStartingMessage( ReportEntry report )
      {
          StringBuffer message = new StringBuffer();
          message.append( TEST_SET_STARTING_PREFIX );
          message.append( report.getName() );
  
          if ( report.getGroup() != null && !report.getName().equals( report.getGroup() ) )
          {
              message.append( TEST_SET_STARTING_GROUP_PREFIX );
              message.append( report.getGroup() );
              message.append( TEST_SET_STARTING_GROUP_SUFIX );
          }
          return message.toString();
      }
  
      /**
       * Parses a Surefire test set starting message into a {@link ReportEntry} object.
      * Only name and group will be set if applicable.
      *
      * @param message The test starting message
      * @return the parsed {@link ReportEntry}
      */
     public static ReportEntry parseTestSetStartingMessage( String message )
     {
         String name;
         String group = null;
         int i = message.indexOf( TEST_SET_STARTING_GROUP_PREFIX );
         int j;
         if ( i >= 0 )
         {
             j = message.indexOf( TEST_SET_STARTING_GROUP_SUFIX );
             if ( j <= 0 )
             {
                 throw new RuntimeException( "Message provided can not be parsed" );
             }
             group = message.substring( i + TEST_SET_STARTING_GROUP_PREFIX.length(), j );
         }
         else
         {
             i = message.length();
             if ( i <= 0 )
             {
                 throw new RuntimeException( "Message provided can not be parsed" );
             }
         }
         name = message.substring( TEST_SET_STARTING_PREFIX.length(), i );
         return CategorizedReportEntry.nameGroup( name, group );
     }
 
     /**
      * Check if the String passed as argument is a "test starting" message.
      * If so it can be passed to {@link #parseTestSetStartingMessage(String)}
      *
      * @param message the message to check
      * @return true if it is a "test starting" message
      */
     public static boolean isTestSetStartingMessage( String message )
     {
         return message.startsWith( TEST_SET_STARTING_PREFIX );
     }
 
 }