es.upm.dit.gsi.beast.reader.CreateEvaluation Maven / Gradle / Ivy

Go to download
package es.upm.dit.gsi.beast.reader;

import java.io.File;
import java.io.IOException;
import java.util.logging.Logger;

import junit.framework.Assert;

import org.apache.ws.jaxme.js.JavaComment;
import org.apache.ws.jaxme.js.JavaMethod;
import org.apache.ws.jaxme.js.JavaQName;
import org.apache.ws.jaxme.js.JavaQNameImpl;
import org.apache.ws.jaxme.js.JavaSource;
import org.apache.ws.jaxme.js.JavaSourceFactory;

import es.upm.dit.gsi.beast.story.phases.Evaluation;

/**
 * Main class to create the evaluation of each Test. The evaluation represents
 * the THEN part of our BDD Test.
 * 
 * @author Jorge Solitario
 */
public class CreateEvaluation {

    /**
     * Method to create the evaluation of each test. IT does not check if the
     * file is already created, overwriting it.
     * 
     * @param scenario_name
     *            The name given by the client
     * @param path
     *            The package of the test
     * @param client_description
     *            The plain text given by the client in the THEN part
     * @param dest_dir
     *            the working directory (typically src/main/java)
     */
    public static void createEvaluation(String scenario_name, String path,
            String client_description, String dest_dir) {
        Logger logger = Logger.getLogger("CreateEvaluation");

        JavaSourceFactory factory = new JavaSourceFactory();

        JavaQName className = JavaQNameImpl.getInstance(path, "Evaluation");
        JavaSource js = factory.newJavaSource(className, "public");
        js.addImport(Assert.class);

        js.newComment();
        JavaComment classComment = js.getComment();
        classComment.addLine(" ");
        classComment
                .addLine("This is the class that must create the Evaluation.");
        classComment.addLine("It is related with the THEN part.");
        classComment.addLine(" ");
        classComment
                .addLine("In checkStates method the following method must be used");
        classComment
                .addLine("   checkAgentsBeliefEquealsTo(agent_name,belief_name,expected_belief_value)");
        classComment.addAuthor("es.upm.dit.gsi.beast");

        JavaMethod jm = js.newJavaMethod("checkStates", "void", "public");
        jm.addLine("// TODO implement this method to represent the @Then part of the test in Java code.");
        jm.addLine("logger.warning(\"Implement checkStates() method in "
                + path
                + ".Evaluation"
                + scenario_name
                + ".java -> Auto-generated stub by Beast -> es.upm.dit.gsi.beast-tool\");");
        jm.addLine("Assert.fail(\"Not implemented Test. Auto-generated stub by Beast -> es.upm.dit.gsi.beast-tool\");");
        jm.addLine("\n    //EXAMPLE: checkAgentsBeliefEquealsTo(\"Steve\", \"age\", 21);");
        
        jm.newComment();
        JavaComment methodComment = jm.getComment();
        methodComment.addLine(" ");
        methodComment
                .addLine("Here the description given by the client must be written,");
        methodComment.addLine("which is: ");
        methodComment.addLine(" ");
        methodComment.addLine("  " + client_description);

        js.addExtends(Evaluation.class);
        // logger.info("Evaluation"+scenario_name+" has been created in "+dest_dir+Reader.createFolderPath(path));
        try {
            factory.write(new File(dest_dir));
        } catch (IOException e) {
            logger.severe("ERROR writing the evaluation of " + scenario_name);
        }
    }
}