SourceCodeAnalyserTaskTest.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.sourcecodeanalyser;

import java.io.File;

import junit.framework.TestCase;

import org.squale.jraf.commons.exception.JrafDaoException;
import org.squale.squalecommon.SqualeTestCase;
import org.squale.squalecommon.daolayer.component.ProjectDAOImpl;
import org.squale.squalecommon.daolayer.component.ProjectParameterDAOImpl;
import org.squale.squalecommon.enterpriselayer.businessobject.component.ApplicationBO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.AuditBO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.ProjectBO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.MapParameterBO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.ParametersConstants;
import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.StringParameterBO;
import org.squale.squalecommon.enterpriselayer.businessobject.rule.QualityGridBO;
import org.squale.squalix.core.AbstractTask;
import org.squale.squalix.core.TaskData;
import org.squale.squalix.tools.compiling.utility.FileManager;
import org.squale.squalix.util.file.FileUtility;

/**
 * Test pour la r�cup�ration des sources via une arborescence de fichiers
 */
public class SourceCodeAnalyserTaskTest
    extends SqualeTestCase
{

    /** Le zip contenant les sources et les .class */
    public static final String ZIP_DIR = "data/Project4AnalyserTest/testCommon.zip";

    /** Le r�pertoire contenant les sources, les .class, le .classpath, le .project */
    public static final String ROOT_DIR = "data/samples/testCommon";

    /** l'application */
    private ApplicationBO mAppli = new ApplicationBO();

    /** le projet � auditer */
    private ProjectBO mProject = new ProjectBO();

    /** l'audit */
    private AuditBO mAudit = new AuditBO();

    /** Les param�tres temporaires */
    private TaskData mData = new TaskData();

    /**
     * Constructeur pour SourceCodeAnalyserTaskTest.
     * 
     * @param arg0 nom
     */
    public SourceCodeAnalyserTaskTest( String arg0 )
    {
        super( arg0 );

    }

    /**
     * @see TestCase#setUp()
     */
    protected void setUp()
        throws Exception
    {
        super.setUp();
        getSession().beginTransaction();
        mAppli = getComponentFactory().createApplication( getSession() );
        QualityGridBO grid = getComponentFactory().createGrid( getSession() );
        mProject = getComponentFactory().createProject( getSession(), mAppli, grid );
        // Enregistrement du ProjectBO dans la base
        ProjectDAOImpl projectDAO = ProjectDAOImpl.getInstance();
        MapParameterBO params = new MapParameterBO();
        MapParameterBO analyserParams = new MapParameterBO();
        StringParameterBO zipParam = new StringParameterBO();
        zipParam.setValue( ROOT_DIR );
        analyserParams.getParameters().put( ParametersConstants.PATH, zipParam );
        params.getParameters().put( ParametersConstants.ANALYSER, analyserParams );
        ProjectParameterDAOImpl.getInstance().create( getSession(), params );
        mProject.setParameters( params );
        ProjectDAOImpl.getInstance().save( getSession(), mProject );
        mAudit = getComponentFactory().createAudit( this.getSession(), mProject );
        // On fait le commit pour permettre l'acc�s aux donn�es dans une autre session
        getSession().commitTransactionWithoutClose();
    }

    /**
     * @param path le chemin du projet
     * @throws JrafDaoException si erreur
     */
    private void setParameters( String path )
        throws JrafDaoException
    {
        // Enregistrement du ProjectBO dans la base
        ProjectDAOImpl projectDAO = ProjectDAOImpl.getInstance();
        MapParameterBO params = new MapParameterBO();
        MapParameterBO analyserParams = new MapParameterBO();
        StringParameterBO zipParam = new StringParameterBO();
        zipParam.setValue( path );
        analyserParams.getParameters().put( ParametersConstants.PATH, zipParam );
        params.getParameters().put( ParametersConstants.ANALYSER, analyserParams );
        ProjectParameterDAOImpl.getInstance().create( getSession(), params );
        mProject.setParameters( params );
        ProjectDAOImpl.getInstance().save( getSession(), mProject );
        mAudit = getComponentFactory().createAudit( this.getSession(), mProject );
    }

    /**
     * On teste le cas d'un projet compress�
     * 
     * @throws JrafDaoException si erreur
     */
    public void testAnalyseWithZip()
        throws JrafDaoException
    {
        setParameters( ZIP_DIR );
        SourceCodeAnalyserTask task = new SourceCodeAnalyserTask();
        task.setData( mData );
        task.setAuditId( new Long( mAudit.getId() ) );
        task.setProjectId( new Long( mProject.getId() ) );
        task.setApplicationId( new Long( mAppli.getId() ) );
        task.setStatus( AbstractTask.NOT_ATTEMPTED );
        task.run();
        assertEquals( AbstractTask.TERMINATED, task.getStatus() );
        File root = new File( "data/Project4AnalyserTest/source_code_analyser/" );
        File project = new File( root, "testCommon" );
        assertTrue( project.exists() );
        final int nbDir = 2;
        assertEquals( nbDir, FileManager.checkFileNumber( project.getAbsolutePath(), ".java" ).size() );
        FileUtility.deleteRecursively( root );
    }

    /**
     * On teste le cas d'un r�pertoire non compress�
     * 
     * @throws JrafDaoException si erreur
     */
    public void testAnalyseWithDir()
        throws JrafDaoException
    {
        setParameters( ROOT_DIR );
        SourceCodeAnalyserTask task = new SourceCodeAnalyserTask();
        task.setData( mData );
        task.setAuditId( new Long( mAudit.getId() ) );
        task.setProjectId( new Long( mProject.getId() ) );
        task.setApplicationId( new Long( mAppli.getId() ) );
        task.setStatus( AbstractTask.NOT_ATTEMPTED );
        task.run();
        assertEquals( AbstractTask.TERMINATED, task.getStatus() );
        File root = new File( "data/Project4AnalyserTest/source_code_analyser/" );
        File project = new File( root, "testCommon" );
        assertTrue( project.exists() );
        final int nbDir = 5;
        assertEquals( nbDir, project.listFiles().length );
        FileUtility.deleteRecursively( root );
    }

}