CppTestWorkSpace.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale 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 Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.squalix.tools.cpptest;

import java.io.File;
import java.io.IOException;
import java.util.Collection;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.squale.squalix.util.file.FileUtility;

/**
 * Espace de travail utilis� pour la g�n�ration CppTest CppTest utilise des r�pertoires pendant son ex�cution, un
 * r�pertoire servant � g�n�rer les donn�es du projet CppTest, l'autre servant � g�n�rer les rapports. Ces r�pertoires
 * sont transitoires.
 */
public class CppTestWorkSpace
{
    /** Extension d'un rapport CppTest */
    static final String REPORT_EXTENSION = ".xml";

    /**
     * Logger
     */
    private static final Log LOGGER = LogFactory.getLog( CppTestWorkSpace.class );

    /** R�pertoire racine */
    private File mRootDir;

    /** R�pertoire des rapports */
    private File mReportDirectory;

    /** Project CppTest */
    private File mProjectFile;

    /**
     * Constructeur
     * 
     * @param pRootDir r�pertoire racine
     * @throws IOException si erreur de cr�ation des r�pertoires
     */
    public CppTestWorkSpace( File pRootDir )
        throws IOException
    {
        // Cr�ation du r�pertoire correspondant
        mRootDir = pRootDir;
        createDirectory( pRootDir );
        // Cr�ation du r�pertoire pour le projet
        File projectDir = new File( mRootDir, "project" );
        createDirectory( projectDir );
        mProjectFile = new File( projectDir, "project.cpf" );
        // Cr�ation du r�pertoire pour le rapport
        mReportDirectory = new File( mRootDir, "report" );
        createDirectory( mReportDirectory );
    }

    /**
     * Cr�ation du r�pertoire
     * 
     * @param pDirectory r�pertoire � cr�er
     * @throws IOException si la cr�ation ne peut se faire
     */
    private void createDirectory( File pDirectory )
        throws IOException
    {
        if ( false == pDirectory.mkdirs() )
        {
            String message = CppTestMessages.getString( "error.create_directory", pDirectory.getAbsolutePath() );
            LOGGER.error( message );
            throw new IOException( message );
        }
    }

    /**
     * Nettoyage des r�p�rtoires Le r�pertoire racine est d�truit r�cursivement
     */
    public void cleanup()
    {
        // Effacement du r�pertoire de rapport
        FileUtility.deleteRecursively( mRootDir );
    }

    /**
     * Recherche des rapports
     * 
     * @return rapports au format XML g�n�r�s par CppTest
     */
    public Collection getReportFiles()
    {
        // Recherche des rapports
        Collection files = FileUtility.findFilesWithSuffix( getReportDirectory(), REPORT_EXTENSION );
        return files;
    }

    /**
     * @return projet CppTest
     */
    public File getProjectFile()
    {
        return mProjectFile;
    }

    /**
     * @return r�pertoire de g�n�ration de rapport
     */
    public File getReportDirectory()
    {
        return mReportDirectory;
    }

}