org.apache.maven.surefire.booter.DumpErrorSingleton Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of surefire-api Show documentation

API used in Surefire and Failsafe MOJO, Booter, Common and test framework providers.

There is a newer version: 3.5.2

package org.apache.maven.surefire.booter;

/*
 * 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 org.apache.maven.surefire.util.internal.DumpFileUtils;

import java.io.File;

import static org.apache.maven.surefire.util.internal.DumpFileUtils.newDumpFile;

/**
 * Dumps lost commands and caused exceptions in forked JVM. 

 * Fail-safe.
 *
 * @author Tibor Digana (tibor17)
 * @since 2.20
 */
public final class DumpErrorSingleton
{
    public static final String DUMP_FILE_EXT = ".dump";
    public static final String DUMPSTREAM_FILE_EXT = ".dumpstream";
    private static final DumpErrorSingleton SINGLETON = new DumpErrorSingleton();

    private File dumpFile;
    private File dumpStreamFile;

    private DumpErrorSingleton()
    {
    }

    public static DumpErrorSingleton getSingleton()
    {
        return SINGLETON;
    }

    public synchronized void init( File reportsDir, String dumpFileName )
    {
        dumpFile = createDumpFile( reportsDir, dumpFileName );
        dumpStreamFile = createDumpStreamFile( reportsDir, dumpFileName );
    }

    public synchronized void dumpException( Throwable t, String msg )
    {
        DumpFileUtils.dumpException( t, msg == null ? "null" : msg, dumpFile );
    }

    public synchronized void dumpException( Throwable t )
    {
        DumpFileUtils.dumpException( t, dumpFile );
    }

    public synchronized void dumpText( String msg )
    {
        DumpFileUtils.dumpText( msg == null ? "null" : msg, dumpFile );
    }

    public synchronized void dumpStreamException( Throwable t, String msg )
    {
        DumpFileUtils.dumpException( t, msg == null ? "null" : msg, dumpStreamFile );
    }

    public synchronized void dumpStreamException( Throwable t )
    {
        DumpFileUtils.dumpException( t, dumpStreamFile );
    }

    public synchronized void dumpStreamText( String msg )
    {
        DumpFileUtils.dumpText( msg == null ? "null" : msg, dumpStreamFile );
    }

    private File createDumpFile( File reportsDir, String dumpFileName )
    {
        return newDumpFile( reportsDir, dumpFileName + DUMP_FILE_EXT );
    }

    private File createDumpStreamFile( File reportsDir, String dumpFileName )
    {
        return newDumpFile( reportsDir, dumpFileName + DUMPSTREAM_FILE_EXT );
    }
}