Submission Jar: test case + Ant build script

[Roel De Nijs]

Hi all,

This is the test case (JUnit 4) I used to check if the submission jar is valid and contains all necessary files (in the appropriate directories). It checks also some source requirements:
- are interfaces DBMain (= Sun's interface) and Data in the correct package?
- are the exceptions (mentioned in Sun's interface) in the correct package?
- does Data implement DBMain?
- do the exceptions (mentioned in Sun's interface) have 2 constructors: one with zero-argument constructor and one with String argument?

My assignment was URLyBird 1.3.1, so if you have another assignment, make sure you make the necessary changes to the test case before using it. I decided also to have a simple plain text userguide. So if you have a HTML one, you will need to make changes too.

    
public class TestJarSubmission {

    private static final String DIR_SUBMISSION_JAR = ...; // path to the directory where you unjarred the submission jar

    /**
     * A directory called code, containing all the source code and related parts
     * of your project. You must create subdirectories within this to reflect
     * your package structure and distribute your source files within those
     * directories.
     */
    private static final String DIR_CODE = "code";

    /**
     * A directory called docs, containing the following items at the top level.
     */
    private static final String DIR_DOCS = "docs";

    /**
     * A subdirectory called javadoc, containing HTML/Javadoc documentation for
     * all classes and interfaces you are submitting.
     */
    private static final String DIR_JAVADOC = DIR_DOCS + "/javadoc";

    /**
     * The original, unchanged database file that was supplied to you. Note that
     * you must keep a copy of the original database file supplied to you, and
     * this must be the file you submit. The marking process will expect the
     * exact same data without any changes.
     */
    private static final String FILE_DB = "db-1x1.db";

    /**
     * A file called choices.txt that containing pure ASCII (not a word
     * processor format) text describing the significant design choices you
     * made. Detail the problems you perceived, the issues surrounding them,
     * your value judgments, and the decisions that you made. This document
     * should also describe any uncertainties you had regarding the project, and
     * the decisions you made when resolving them.
     */
    private static final String FILE_CHOICES = DIR_DOCS + "/choices.txt";

    /**
     * The executable JAR containing the programs. This must be called
     * runme.jar.
     */
    private static final String FILE_EXECUTABLE_JAR = "runme.jar";

    /**
     * This html file.
     */
    private static final String FILE_INSTRUCTIONS = DIR_DOCS
            + "/instructions.html";

    /**
     * The index.html file of the HTML/Javadoc documentation.
     */
    private static final String FILE_JAVADOC = DIR_JAVADOC + "/index.html";

    /**
     * User documentation for the database server and the gui client. If your
     * user documentation is online then you may omit this file. However, if the
     * documentation is not online, you must provide either a single plain ASCII
     * (not word processor format) text document, which must be called
     * userguide.txt, or multiple HTML files which must all be accessible from a
     * starting point document that must be called userguide.html.
     */
    private static final String FILE_USERGUIDE = DIR_DOCS + "/userguide.txt";

    /**
     * A file called version.txt. This must contain pure ASCII (not a word
     * processor format) indicating the exact version of JDK you used, and the
     * host platform you worked on.
     */
    private static final String FILE_VERSION = "version.txt";

    /**
     * The required data access class (Data).
     */
    private static final String SOURCE_DATA = DIR_CODE
            + "/suncertify/db/Data.java";

    /**
     * The required interface (DBMain).
     */
    private static final String SOURCE_DBMAIN = DIR_CODE
            + "/suncertify/db/DBMain.java";

    /**
     * The required exception DuplicateKeyException.
     */
    private static final String SOURCE_EXCEPTION_DK = DIR_CODE
            + "/suncertify/db/DuplicateKeyException.java";

    /**
     * The required exception RecordNotFoundException.
     */
    private static final String SOURCE_EXCEPTION_RNF = DIR_CODE
            + "/suncertify/db/RecordNotFoundException.java";

    /**
     * The required directories in the submission jar.
     */
    private static final String[] REQUIRED_DIRECTORIES = new String[] {
            DIR_CODE, DIR_DOCS, DIR_JAVADOC };

    /**
     * The expected count of required directories in the submission jar.
     */
    private static final int REQUIRED_DIRECTORIES_COUNT = 3;

    /**
     * The required files in the submission jar.
     */
    private static final String[] REQUIRED_FILES = new String[] { FILE_DB,
            FILE_CHOICES, FILE_EXECUTABLE_JAR, FILE_INSTRUCTIONS, FILE_JAVADOC,
            FILE_USERGUIDE, FILE_VERSION };

    /**
     * The expected count of required files in the submission jar.
     */
    private static final int REQUIRED_FILES_COUNT = 7;

    /**
     * The required sources in the submission jar.
     */
    private static final String[] REQUIRED_SOURCES = new String[] {
            SOURCE_DATA, SOURCE_DBMAIN, SOURCE_EXCEPTION_DK,
            SOURCE_EXCEPTION_RNF };

    /**
     * The expected count of required sources in the submission jar.
     */
    private static final int REQUIRED_SOURCES_COUNT = 4;

    /**
     * Test for the required directories in the submission jar.
     */
    @Test
    public void testRequiredDirectories() {
        Assert.assertEquals(REQUIRED_DIRECTORIES_COUNT,
                REQUIRED_DIRECTORIES.length);
        for (String directory : REQUIRED_DIRECTORIES) {
            File f = new File(DIR_SUBMISSION_JAR, directory);
            Assert.assertTrue("directory '" + directory + "' not exists", f
                    .exists());
        }
    }

    /**
     * Test for the required files in the submission jar.
     */
    @Test
    public void testRequiredFiles() {
        Assert.assertEquals(REQUIRED_FILES_COUNT, REQUIRED_FILES.length);
        for (String file : REQUIRED_FILES) {
            File f = new File(DIR_SUBMISSION_JAR, file);
            Assert.assertTrue("file '" + file + "' not exists", f.exists());
        }
    }

    /**
     * Test for the required source files in the submission jar.
     */
    @Test
    public void testRequiredSources() {
        Assert.assertEquals(REQUIRED_SOURCES_COUNT, REQUIRED_SOURCES.length);
        for (String source : REQUIRED_SOURCES) {
            File f = new File(DIR_SUBMISSION_JAR, source);
            Assert.assertTrue("source '" + source + "' not exists", f.exists());
        }
    }

    /**
     * Test for the following source requirements:
     * <ul>
     * <li>Your data access class must implement the interface DBMain</li>
     * <li>Any unimplemented exceptions in the interface DBMain must have a zero
     * argument constructor and a second constructor that takes a String that
     * serves as the exception's description.
     * </ul>
     */
    @Test
    public void testSourceRequirements() {
        // check data access class
        try {
            Class<?> clazz = Class.forName("suncertify.db.Data");
            Assert.assertTrue("DBMain is not assignable from " + clazz,  
              DBMain.class.isAssignableFrom(clazz));  
        } catch (ClassNotFoundException e1) {
            Assert.fail("data access class not found");
        }
        // check the unimplemented exceptions
        final Class<?>[] exceptionClasses = { RecordNotFoundException.class,
                DuplicateKeyException.class };
        for (Class<?> exceptionClass : exceptionClasses) {
            // a zero argument constructor
            try {
                exceptionClass.getConstructor((Class[]) null);
            } catch (SecurityException e) {
                Assert.fail("security violation");
            } catch (NoSuchMethodException e) {
                Assert.fail("the zero argument constructor not found");
            }
            // a constructor with String argument
            try {
                exceptionClass.getConstructor(String.class);
            } catch (SecurityException e) {
                Assert.fail("security violation");
            } catch (NoSuchMethodException e) {
                Assert.fail("constructor not found");
            }
        }
    }

}

And this is the Ant build script. I put this script in the root of my sources and defined all directories (in the build script) with a relative path. After building the submission jar I executed all tests I had (including the test case above). And of course the build script just copies the necessary files, no moving or deleting (except for the generated files of course). So you don't have to worry that suddenly your source files disappeared for example
The build script creates:
- the runme.jar
- the javadoc (for all members/classes except private ones, and creates also links for every class from the Java API)
- the RMI stubs (if you don't want it, just comment/delete the line <rmic ... />)
- the submission jar

Just complete the properties and then you can run the build script with the target of your choice (javadoc, create-executable-jar, create-submission-jar or the default one buildAndTest).

    
<project name="suncertify" default="buildAndTest" basedir=".">

    <property name="your.name" value="" description="your name" />
    <!-- computer settings -->
    <property name="proxy.host" value="" 
        description="the host name of the proxy server (if applicable)" />
    <property name="proxy.port" value="" 
        description="the port number of the proxy server (default value = 80) (if applicable)" />
    <!-- build settings -->
    <property name="dir.output" value="output" 
        description="the directory containing all generated files" />
    <property name="dir.source" value="src" 
        description="the source directory" />
    <property name="dir.test" value="" 
        description="the source directory of the test files" />
    <property name="dir.temp" value="${dir.output}/temp" 
        description="the directory containing temporary files" />
    <property name="dir.temp.assignment" value="${dir.temp}/assignment" 
        description="the directory with the extracted files from assignment jar" />
    <property name="dir.temp.classes" value="${dir.temp}/classes" 
        description="the directory with the compiled source files" />
    <property name="dir.temp.submission" value="${dir.temp}/submission" 
        description="the directory with the extracted files from the created submission jar" />
    <property name="dir.temp.test" value="${dir.temp}/test" 
        description="the directory with the compiled test files" />
    <property name="dir.submission" value="${dir.output}/submission" 
        description="the directory containing all files for submission" />
    <property name="dir.submission.code" value="${dir.submission}/code" 
        description="the required directory code (in the submission jar)" />
    <property name="dir.submission.docs" value="${dir.submission}/docs" 
        description="the required directory docs (in the submission jar)" />
    <property name="dir.submission.javadoc" value="${dir.submission.docs}/javadoc" 
        description="the required directory javadoc (in the submission jar) with the Javadoc/HTML files" />

    <property name="file.choices" value="choices.txt" 
        description="the required file choices.txt" />
    <property name="file.db" value="${dir.temp.assignment}/db-1x1.db" 
        description="the required original, unchanged database file" />
    <property name="file.instructions" value="${dir.temp.assignment}/instructions.html" 
        description="the required file instructions.html" />
    <property name="file.userguide" value="userguide.txt" 
        description="the required file userguide.txt" />
    <property name="file.version" value="version.txt" 
        description="the required file version.txt" />

    <property name="jar.assignment" value="ASSIGNMENT.jar" 
        description="the assignment jar file (used to copy instructions and database file)" />
    <property name="jar.executable" value="${dir.submission}/runme.jar" 
        description="the executable jar file" />
    <property name="jar.executable.main.class" value="" 
        description="the full qualified name of the main class" />
    <property name="jar.submission" value="" 
        description="the submission jar file" />

    <property name="javadoc.title" value="" 
        description="the title of the generated overview page" />

    <target name="clean" 
            description="delete all generated files">
        <delete dir="${dir.output}" failonerror="true" />
    </target>

    <target name="prepare" depends="clean" 
            description="creates all necessary directories">
        <mkdir dir="${dir.temp.assignment}" />
        <mkdir dir="${dir.temp.classes}" />
        <mkdir dir="${dir.temp.submission}" />
        <mkdir dir="${dir.temp.test}" />
        <mkdir dir="${dir.submission.code}" />
        <mkdir dir="${dir.submission.docs}" />
        <mkdir dir="${dir.submission.javadoc}" />
    </target>

   <target name="javadoc" depends="prepare" 
            description="create the javadoc for the source files">
        <javadoc sourcepath="${dir.source}" 
                 destdir="${dir.submission.javadoc}" 
                 access="package" 
                 doctitle="${javadoc.title}" 
                 overview="${dir.source}/overview.html" 
                 failonerror="true" 
                 classpath="." 
                 nodeprecated="false" 
                 nodeprecatedlist="false" 
                 noindex="false" 
                 nonavbar="false" 
                 notree="false"
                 splitindex="true" 
                 author="true" 
                 use="true" 
                 version="true">
            <arg value="-J-Dhttp.proxyHost=${proxy.host}" />
            <arg value="-J-Dhttp.proxyPort=${proxy.port}" />
            <link href="http://java.sun.com/javase/6/docs/api/" />
        </javadoc>
    </target>

    <target name="create-executable-jar" depends="prepare" 
            description="create the executable jar">
        <!-- compile the source files -->
        <javac srcdir="${dir.source}" destdir="${dir.temp.classes}" listfiles="true" failonerror="true" />
        <!-- compile stubs and skeletons (using rmic) -->
        <rmic base="${dir.temp.classes}" verify="true" debug="true" />
        <!-- jar all classes -->
        <jar destfile="${jar.executable}" basedir="${dir.temp.classes}">
            <manifest>
                <attribute name="Built-By" value="${your.name}" />
                <attribute name="Main-Class" value="${jar.executable.main.class}" />
                <attribute name="Class-Path" value="." />
            </manifest>
        </jar>
    </target>

    <target name="create-submission-jar" depends="create-executable-jar, javadoc" 
            description="create the submission jar file">
        <!-- unjar assignment jar -->
        <unjar src="${jar.assignment}" dest="${dir.temp.assignment}" />
        <!-- copy the source files -->
        <copy todir="${dir.submission.code}" failonerror="true">
            <fileset dir="${dir.source}" />
        </copy>
        <!-- copy the required files to their appropriate directory -->
        <copy todir="${dir.submission}" failonerror="true">
            <fileset file="${file.db}" />
            <fileset file="${file.version}" />
        </copy>
        <copy todir="${dir.submission.docs}" failonerror="true">
            <fileset file="${file.choices}" />
            <fileset file="${file.instructions}" />
            <fileset file="${file.userguide}" />
        </copy>
        <!-- jar all these files -->
        <jar destfile="${jar.submission}" basedir="${dir.submission}">
            <manifest>
                <attribute name="Built-By" value="${your.name}" />
            </manifest>
        </jar>
    </target>

    <target name="buildAndTest" depends="create-submission-jar">
        <!-- unjar submission jar -->
        <unjar src="${jar.submission}" dest="${dir.temp.submission}" />
        <!-- compile the test files -->
        <javac srcdir="${dir.test}" destdir="${dir.temp.test}" listfiles="true" failonerror="true">
            <classpath>
                <pathelement location="${dir.temp.classes}" />
            </classpath>
        </javac>
        <!-- copy the resources directory -->
        <copy todir="${dir.temp.test}/resources">
            <fileset dir="${dir.test}/resources" />
        </copy>
        <!-- execute tests -->
        <junit printsummary="true" haltonfailure="true">
            <classpath id="test.class.path">
                <pathelement location="${dir.temp.classes}" />
                <pathelement location="${dir.temp.test}" />
                <pathelement path="${java.class.path}" />
            </classpath>
            <test fork="true" name="suncertify.test.TestJarSubmission" />
        </junit>
        <java fork="true" jar="${jar.executable}" failonerror="true" />
    </target>

</project>

This build script was for me a real life-saver, because I submitted my assignment just 15 minutes before I had to leave to take the essay exam (making my choices.txt took a whole lot longer than I thought) and thanks to this build script I was 100% sure that I wasn't forgetting anything and my submission jar was

If you should have any questions about use or modifications, just let me know by replying to this thread (and I'll try answering them).

Good luck with your assignments!
Kind regards,
Roel

[edit] changed the javadoc target and increase readibility (according to Andrew's remark)

[Roberto Perillo]

Howdy, Roel!!!

This is great! Thank you so much for sharing this valuable tool. I'm sure this will be of great value to everyone still working on the assignment, and certainly will help people to submit the final project with everything in the right place.

[Roel De Nijs]

Hi all,

Everybody knows Roberto Perillo 's famous data locking test (you can find it here). It is easy to add this test to the build script:
- first modify the test so it 's adapted to your Data class
- be sure to put the test in the test directory (property "dir.test")
- then just add the following line to the target "buildAndTest" (after the comment "execute tests")

    
<java fork="true" classname="suncertify.tests.DataClassTest" classpathref="test.class.path" failonerror="true" />

That's it! And likewise you can add every test you want to the build script. If the test is a JUnit test case then you have to add it like the TestJarSubmission test is added. If it is just a Java program then you can add just as Roberto's data locking test.

Kind regards,
Roel

[Andrew Monkhouse]

Hi Roel,

This is great - thanks for sharing. Do you feel like adding a link to this in the JavaRanch SCJD FAQ? (The FAQ is just a wiki page - you can edit it yourself).

Roel De Nijs wrote:to have a bit a readible thread I changed the javadoc call a bit: if you want to use the build file you just have to delete ...> and <...

To get around that particular problem, I tend to split my lines - even in the production code. I personally feel the following is a little easier to read (and a little easier to remove a single line if I need to):

    
    <target name="javadoc" depends="prepare" description="create the javadoc for the source files">
        <javadoc sourcepath="${dir.source}" 
                 destdir="${dir.submission.javadoc}" 
                 access="package" 
                 doctitle="${javadoc.title}" 
                 overview="${dir.source}/overview.html" 
                 failonerror="true" 
                 classpath="." 
                 nodeprecated="false" 
                 nodeprecatedlist="false" 
                 noindex="false" 
                 nonavbar="false" 
                 notree="false"
                 splitindex="true" 
                 author="true" 
                 use="true" 
                 version="true">
            <arg value="-J-Dhttp.proxyHost=${proxy.host}" />
            <arg value="-J-Dhttp.proxyPort=${proxy.port}" />
            <link href="http://java.sun.com/javase/6/docs/api/" />
        </javadoc>
    </target>

[Roel De Nijs]

Andrew Monkhouse wrote:To get around that particular problem, I tend to split my lines - even in the production code.

Normally I also split my lines (because indeed it is easier to read/maintain), I have no idea why I didn't do it here

Andrew Monkhouse wrote:Do you feel like adding a link to this in the JavaRanch SCJD FAQ?

I added the link.

Kind regards,
Roel

[Alecsandru Cocarla]

There is also a similar test and ant script - https://coderanch.com/t/189448/Developer-Certification-SCJD/certification/Assignment-submission-file-structure-verification - these are the ones I used (slightly modified) for my assignment verification test and build script.

What is useful in that ant build and you could also add to yours is the javadoccheck target.

[Roel De Nijs]

Hi Alecsandru,

I never used the doc check utility, so i don't have any idea what it does and what's the added value. I think if you add verbose="true" you will see what javadoc is doing and when a problem occurs (like a parameter that is not defined in the parameter list,...) an error message is shown to the console (cfr. the "Generate Javadoc" menu-item from Eclipse).

Kind regards,
Roel

[Alecsandru Cocarla]

DocCheck generates HTML reports about how well your code is documented. You should try it

[Vasya Pupkin]

Roel, thanks again for your shared code.
I was debating with myself for a while about writing build.xml
I was postponing it till the very last minute, and here you are with your build script.
I finally had some time to run your code. It did not take long to modify everything for my needs (B&S).

Alecsandru Cocarla, thanks for the reference too. PMD and javadoccheck appear to be very helpful.

[Roel De Nijs]

Alecsandru Cocarla wrote:DocCheck generates HTML reports about how well your code is documented. You should try it

I tried the docCheck on my source code and I don't think it has any added value (but of course that is just my opinion). If i take a look at the generated reports it tells me that I have missing comments for 10 methods and I have 4 minor errors of category 4 (Text/Link Error). If i have a closer look I see the following:
- 8 methods don't have comments in DBMain interface (that's normal, because I decided not to change a thing about sun's given interface and have javadoc in my own created interface)
- the other 2 methods without having a comment are the methods values() and valueOf(String) of an enum (probably a normal issue because docCheck should be used with jdk 1.2, 1.3 and 1.4, no specific mention of jdk 1.5 or higher)
- the 4 minor errors are the same: "Html Error in First Sentence --Missing a period" (these errors can be solved by adding a period after {@inheritDoc})

Then of course I added some real javadoc errors to see how docCheck handles these ones: an empty return-tag and a non-existing parameter name after the param-tag. DocCheck shows in the report I have also 3 minor errors of category 3 (Tag Error) and that is as expected. But like I said in a previous post the javadoc tool will show you the same errors:

...
MyInterface.java:72: warning - @return tag has no arguments.
MyInterface.java:59: warning - @param argument "parameter2" is not a parameter name.
...
2 warnings

So no added value at all in my humble opinion.

Vasya Pupkin wrote:PMD and javadoccheck appear to be very helpful.

I also did a test with PMD and I have to say that is really useful. I let PMD check the sources that I submitted and it found approximately 250 violations. But i didn't agree with all the violations (like the one that says you should only have 1 return statement in a method). But it is certainly worth your while. And it has also various plugins for IDE, so if you use it through an IDE you can indicate which rules must be checked and about which you don't care.
I think you should certainly run PMD once to see how you can improve your source code (but of course this is again my humble opinion, because I didn't do it myself but in my defense: I didn't know the existence of this plugin/tool )

Vasya Pupkin wrote:Roel, thanks again for your shared code. I finally had some time to run your code. It did not take long to modify everything for my needs (B&S).

I'm glad it was useful for you.

Kind regards,
Roel

[Nilesh Thali]

Adding Roel's answer from my question about "javadoc -overview" in a separate post:

Roel De Nijs wrote:Hi Nilesh,

This certainly is the first topic having my name in the title

Nilesh Thali wrote:Addressing this to you, Roel, since you created this extremely handy ant build file

Glad I could help and share with the community

It would have been better if you asked your question in the thread where I posted my Ant-file, so everybody using that build file, could also read your question (and my answer). So someone else with the same question, wouldn't have to post it again, because you already did.

More info about the overview comment file, you can read here. This section of the javadoc tool documentation covers all your questions, so I would suggest just reading it and it will (hopefully) clear all your doubts.

Kind regards,
Roel

[Pieter Jacobs]

Hi Roel,

Awesome bud!! Thanks.

I ran this an all ok.
I have the "Bodgitt & Scarper 2.1.2" assignment; and even though is says that my DB class is assignable; I'm still worried because I did not implement DB, but implemented an interface that extends DB; is that really OK?

Sorry I'm just fricken nervous too, because I'm doing the essay exam tomorrow

Thanks again,
Pieter

[Roel De Nijs]

Hi Pieter,

From my assignment:

interface DBMain extends DB {}
class Data implements DBMain {}

If this doesn't have a calming effect, nothing will

Kind regards,
Roel

[Pieter Jacobs]

Hi Roel,

Thanks!!!

Enjoy the evening - or what's left of it

Pieter

[Carlos Morillo]

Hi Roel,

I am trying to generate everything and my submission jar using
your Ant build script as is without any changes in Solaris 10 on SPARC, latest Java 6 JDK
and latest Ant binaries.

I have not used Ant much and I have no clue why is generating that error
generating javadoc but the file is complaining about doesn't exist.
Not sure if that's the issue.

Did I miss anything or any other steps I should have done before?

javadoc:
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package suncertify.db...
[javadoc] Loading source files for package suncertify.direct...
[javadoc] Loading source files for package suncertify.domain...
[javadoc] Loading source files for package suncertify.gui...
[javadoc] Loading source files for package suncertify.remote...
[javadoc] Loading source files for package suncertify.test...
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 1.6.0_18
[javadoc] Building tree for all the packages and classes...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[javadoc] javadoc: error - Error while reading file /home/morillo/src/java/scjd/submission/src/overview.html
[javadoc] Generating /home/morillo/src/java/scjd/submission/output/submission/docs/javadoc/stylesheet.css...
[javadoc] 1 error

BUILD FAILED
/home/morillo/src/java/scjd/submission/build.xml:92: Javadoc returned 1

Total time: 23 seconds
[auyantepui]</home/morillo/src/java/scjd/submission>% java -version
java version "1.6.0_18"
Java(TM) SE Runtime Environment (build 1.6.0_18-b07)
Java HotSpot(TM) Server VM (build 16.0-b13, mixed mode)
[auyantepui]</home/morillo/src/java/scjd/submission>% cat /etc/release
Solaris 10 5/09 s10s_u7wos_08 SPARC
Copyright 2009 Sun Microsystems, Inc. All Rights Reserved.
Use is subject to license terms.
Assembled 30 March 2009
[auyantepui]</home/morillo/src/java/scjd/submission>% file /home/morillo/src/java/scjd/submission/src/overview.html
/home/morillo/src/java/scjd/submission/src/overview.html: cannot open: No such file or directory
[auyantepui]</home/morillo/src/java/scjd/submission>%

Thanks in advance,


Carlos.

[Roel De Nijs]

Carlos,

Do you have an overview.html file in your src directory? Everyhting you need to know about javadoc's overview option can be found in this post

Kind regards,
Roel

[Carlos Morillo]

Hi Roel,

Yes, I was missing that file. I didn't know I had to create it.

I guess I have to create a similar file for every package like in the Denny's DVDs example
in the Monkhouse book.

Now I am getting this error and I have no clue.

create-submission-jar:
[unjar] Expanding: /home/morillo/src/java/scjd/submission/ASSIGNMENT.jar into /home/morillo/src/java/scjd/submission/output/temp/assignment

BUILD FAILED
/home/morillo/src/java/scjd/submission/build.xml:118: Error while expanding /home/morillo/src/java/scjd/submission/ASSIGNMENT.jar

Total time: 24 seconds
[auyantepui]</home/morillo/src/java/scjd/submission>%

Do I need to move or copy instructions.html, choices.txt and userguide.txt anywhere?
They are in the same directory that has build.xml and the src directory containing all my project
source code.

Apologies if this a too basic question.

Thanks,

Carlos.

[Roel De Nijs]

Hi Carlos,

It's pretty easy : the ASSIGNMENT.jar should be placed at the same level as the ant script. The script uses this original jar to extract it and then copy the db file and the instructions.html to the appropriate location in the submission jar. Your userguide and choices.txt should also be place at this level.

Kind regards,
Roel

[Carlos Morillo]

Hi Roel,

Oops!


Makes sense, very clever and pretty cool on your part.

Got that target to work.


Now I think the last target running ant with no parameters I get:

buildAndTest:
[unjar] Expanding: /home/morillo/src/java/scjd/submission/Carlos_Morillo.jar into /home/morillo/src/java/scjd/submission/output/temp/submission
[javac] Compiling 45 source files to /home/morillo/src/java/scjd/submission/output/temp/test
.
.The full path of every file in my source code with [javac] at the beginning of the line
.


BUILD FAILED
/home/morillo/src/java/scjd/submission/build.xml:151: /home/morillo/src/java/scjd/submission/src/resources not found.

Total time: 32 seconds
[auyantepui]</home/morillo/src/java/scjd/submission>%

I think I need to do something also with that Java Source Code at the beginning of your thread
that looks like it's using the reflection API. I guess at least modify it accordingly to my assignment specification.

I am running all of this and editing this by hand from a shell.

Was this supposed to be run from an IDE?

It looks also the class you have at the beginning has to be in the source code hierarchy of the assignment?

I apologize again if this is too basic and if I am supposed to know about this.


Thanks again,


Carlos.

[Roel De Nijs]

Hi Carlos,

I used Eclipse as IDE, which has built-in support for Ant (and will make your life a lot easier when editing some build scripts).

If you just want to create the submission jar, you can change the default target of the ant build (default="create-submission-jar" instead of default="buildAndTest") or you can run the create-submission-jar target instead of the default one (for more info on how to do that, without using an IDE, check the ant pages on the internet). And you won't get this exception.

If you simply want to create the submission jar and afterwards run the test-case TestJarSubmission (which you adapted to your situation and instructions) and/or other tests, you will have to make sure that you define the source directory of the test files (property dir.test) (I used for example another java project for my test cases). If you only want to run the submission jar test, you can delete lines 150 until 153 (included) and you won't get the exception.
I had a lot of test-cases (other than the submission jar test and specific to my assignment and implementation, so I couldn't share them) and they require resources (read: database files, valid ones but also invalid ones: an empty one, one with a wrong cookie value,...). So these lines (150 - 153) just copy these files to another directory. So my test-cases always run from the same starting point, no matter how many times I invoked the build script. That's the purpose of these 4 lines and that's why you got that exception (you don't have a resources directory and you don't need one if you just want to create submission jar and run the test-case TestJarSubmission).

Kind regards,
Roel

[Carlos Morillo]

Hi Roel,

I am using Eclipse too in Windows XP and NetBeans on Solaris 10 and Ubuntu Linux,
but I am afraid of touching the build.xml file that the IDE uses. I don't want to mess up with it.

I thought since you called it script that perhaps it was possible to run it
from the command line. I feel more comfortable doing things from the command line
using Solaris and Linux than using Windows.

Anyway, just to wrap things up and conclude my comments, I did what you suggested
in Solaris and now I get:

BUILD FAILED
/home/morillo/src/java/scjd/submission/build.xml:155: The <classpath> for <junit> must include junit.jar if not in Ant's own classpath

Total time: 32 seconds
[auyantepui]</home/morillo/src/java/scjd/submission>%

which could be solved I guess by adding the JUnit4.jar from NetBeans in Solaris or perhaps
downloading it and adding it to the Classpath.

Anyway, a bit of additional work for me, what I did was the Carlos_Morillo.jar (submission jar) file
created with your build.xml in Solaris, I ftped it to my Windows XP laptop, unjared it and under Eclipse
I created a Junit 4 Test case with your Java code above and the wizard obviously asked me to add
junit.jar to the classpath of my project, did some minor changes like my database file name, interface
name, etc. and ran the TestJarSubmission inside Eclipse and it shows a green bar and green checkmark
4/4 Runs, 0 Errors, 0 Failures, so I think I should be good to go.


Thanks once again for all your help and assistance!


Best Regards,


Carlos.

[Roel De Nijs]

Carlos Morillo wrote:I thought since you called it script that perhaps it was possible to run it from the command line.

You can run it from the command line if you have ant installed, but I don't have any experience with it at all because I use Windows all the time (and now and then use command line to perform basic tasks like ping another ip, retrieve ip address of my pc,...)

Carlos Morillo wrote:which could be solved I guess by adding the JUnit4.jar from NetBeans in Solaris or perhaps downloading it and adding it to the Classpath.

Exactly

Carlos Morillo wrote:it shows a green bar and green checkmark 4/4 Runs, 0 Errors, 0 Failures, so I think I should be good to go.

Finally it's submission time, so you can start your weeks and weeks of waiting for the result

[Roberto Demestri]

After a few tweaks i finally got the script to run; but when the test starts i got
[junit] Running suncertify.tests.TestJarSubmission
[junit] Tests run: 1, Failures: 0, Errors: 1, Time elapsed: 0,016 sec
[junit] Test suncertify.tests.TestJarSubmission FAILED
BUILD SUCCESSFUL
Total time: 15 seconds

how can i know what was wrong ???

[Roel De Nijs]

Run the test on itself (using junit support from your IDE) or add some properties to the junit ant task to provide more output (more info can be found here).

[Michael Enudi]

Hey Roel,

I had done all the submission process and concluded before my eyes fell on this thread. I had to start again, editted the script to suite my cases, struggle through some configuration and at last, I can say the feeling is worth it.
I don't know if I previously did anything wrong but now I just feel more confident.

Thanks for sharing.

[Roel De Nijs]

Michael Enudi wrote:I don't know if I previously did anything wrong but now I just feel more confident.

Thanks for sharing.

Glad to hear it was helpful to you. When I had finished this build script I felt a lot more confident too

[Sean Keane]

Just taking a look over this ANT script and wondering about the line below from the "create-submission-jar" target - what is the idea behind unjaring to a temp directory? This temp directory is not used again in the target. Is it to simply prove you can unjar the file?

<!-- unjar assignment jar -->  
<unjar src="${jar.assignment}" dest="${dir.temp.assignment}" />

EDIT: Ooops, silly question! The JAR referenced by jar.assignment contains the actual files you received from Oracle as part of your assignment. You unjar this JAR file so that the other properties like file.db are valid, as other properties like file.db have been set up to reference the files from this temp directory i.e.

<property name="file.db" value="${dir.temp.assignment}/db-1x1.db"   
        description="the required original, unchanged database file" /> 

A small bit confusing! But I get it now

[Sean Keane]

Many thanks to Roel for providing this handy script. I got it working pretty quickly.

The only changes that I needed to make were:

1. Create the ASSIGNMENT.zip containing the DB file and instructions I received from Oracle.
2. Comment out the copying of the resources directory in the buildAndTest target.
3. I added includeantruntime="false" to any javac calls in the build script (see this post here for further info).

One small change I would suggest is to the testSourceRequirements method in the TestJarSubmission class - just add a message string to the first Assert.assertTrue. See line 5 below:

  public void testSourceRequirements() {
      // check data access class
      try {
          Class<?> clazz = Class.forName("suncertify.db.Data");
          Assert.assertTrue("DBMain is not assignable from " + clazz,
            DBMain.class.isAssignableFrom(clazz));
      } catch (ClassNotFoundException e1) {
          Assert.fail("data access class not found");
      }

I also modified the buildAndTest target to print me out a report (hacked together quickly without structuring nicely - but it works!)
<target name="buildAndTest" depends="create-submission-jar"> <!-- unjar submission jar --> <unjar src="${jar.submission}" dest="${dir.temp.submission}" /> <!-- compile the test files --> <javac srcdir="${dir.test}" destdir="${dir.temp.test}" listfiles="true" failonerror="true" includeantruntime="false"> <classpath> <pathelement path="${jar.junit}"/> <pathelement location="${dir.temp.classes}" /> </classpath> </javac> <!-- copy the resources directory --> <!-- <copy todir="${dir.temp.test}/resources"> <fileset dir="${dir.test}/resources" /> </copy> --> <!-- execute tests --> <delete dir="${dir.temp}/junitresults"/> <mkdir dir="${dir.temp}/junitresults"/> <junit printsummary="true" tempdir="${dir.temp}/junitresults" errorProperty="test.failed" failureProperty="test.failed"> <classpath id="test.class.path"> <pathelement path="${jar.junit}"/> <pathelement location="${dir.temp.classes}" /> <pathelement location="${dir.temp.test}" /> <pathelement path="${java.class.path}" /> </classpath> <formatter type="brief" usefile="false"/> <formatter type="xml"/> <test fork="true" name="suncertify.tests.TestJarSubmission" todir="${dir.temp}/junitresults"/> </junit> <java fork="true" jar="${jar.executable}" failonerror="true" /> <!-- create report --> <junitreport todir="${dir.temp}/junitresults"> <fileset dir="${dir.temp}/junitresults"> <include name="TEST-*.xml"/> </fileset> <report format="frames" todir="${dir.temp}/junitresults"/> </junitreport> <fail if="test.failed" message="Tests failed. See the report here for more details about the failure ${dir.temp}/junitresults" /> </target>

[Roel De Nijs]

Sean Keane wrote:One small change I would suggest is to the testSourceRequirements method in the TestJarSubmission class - just add a message string to the first Assert.assertTrue.

Suggested change applied

[Colin Duggan]

Hi Roel, thanks for the test and build script. I'm trying to send off my submission and running your build script creates the jars however when i try and run the submission jar i get this;

failed to load main-class manifest attribute from

when i look in my manifest file no main class has been specified. In the build script i see that only the name value is set in the manifest.

 <!-- jar all these files -->  
        <jar destfile="${jar.submission}" basedir="${dir.submission}">  
            <manifest>  
                <attribute name="Built-By" value="${your.name}" />  
            </manifest>  
        </jar>  

How does the submission jar write the main class to the manifest if its not mentioned here?Thanks

[Colin Duggan]

Just re read the submission instructions and see that the submission jar contains the executable jar as does the one your script creates. Thanks

[Daniel Kohl]

Hmmm...in my assignment the layout of the .jar is described as a "must", and finally the description doesn't contain a META-INF at root.
Unfortunately the script builds a META-INF-Folder automatically so i ended up in calling the jar-Tool itself (with option M).

Greetings

[Roel De Nijs]

Hi Daniel,

Welcome to the JavaRanch!

Daniel Kohl wrote:Unfortunately the script builds a META-INF-Folder automatically so i ended up in calling the jar-Tool itself (with option M).

I used the ant-script myself and my submission jar also contains a META-INF folder. No need to worry about it, because I passed without any problem.

Kind regards,
Roel

[Anayonkar Shivalkar]

Daniel Kohl wrote:Hmmm...in my assignment the layout of the .jar is described as a "must", and finally the description doesn't contain a META-INF at root.
Unfortunately the script builds a META-INF-Folder automatically so i ended up in calling the jar-Tool itself (with option M).

Greetings

Welcome to CodeRanch!

I'm not sure, but I guess in the requirement document, there is a command given - which will be used to run your jar (e.g. java -jar runme.jar). At that time, there has to be someone to tell Java that which is the main class (i.e. entry point). That is the purpose of META-INF/manifest.mf file.

Just like Roel De Nijs, even my jar also did contain that dir - rather I myself put that entry in jar (I did not use this ant script though), so you should not worry about that.

I hope this helps.

[Daniel Kohl]

Anayonkar Shivalkar wrote:
I'm not sure, but I guess in the requirement document, there is a command given - which will be used to run your jar (e.g. java -jar runme.jar). At that time, there has to be someone to tell Java that which is the main class (i.e. entry point). That is the purpose of META-INF/manifest.mf file.

Yes, indeed, the runme.jar needs a META-INF, but that's not the point here.

The packaging-jar AROUND ALL FILES (the submission-package), will also have a useless META-INF using this ant-script.
That's not mentionend in the requirement and the described layout is a must-requirement.


Greetings

[Anayonkar Shivalkar]

Daniel Kohl wrote:The packaging-jar AROUND ALL FILES (the submission-package), will also have a useless META-INF using this ant-script.
That's not mentionend in the requirement and the described layout is a must-requirement.

Ah... now I got it. Well, as mentioned, I did not use that ant script, so there was no such MET-INF directory in main jar.

But of course, if Roel is saying that there's no problem, then you gotta trust that

[Daniel Kohl]

Yes, of course! I trust him! But finally the decision is made by the examiner(s).

[Marcin Mroczkowski]

I think line length checks for all .java files could be really useful. It's one of most controversial rules in Java code conventions, but it's still there and it's really easy to miss this flaw during code review.

My suggestion: do some recurrent directory scan, get all .java files, scan all lines:
- if line is longer than 80, output warning
- if line is longer than 100, fail test


True example, eclipse formatter can be been killed by this line:

            Thread.setDefaultUncaughtExceptionHandler(new Xxxxxxxxxxxxx.Xxxxxxxxxxxxxxxxxxxxxxxx());

Eclipse on "Java Code Conventions" formatter preset, will not wrap things like this and it creates room for possible point loss.

[Roel De Nijs]

In my opinion this particular code convention is outdated. During development we use a line length of 120-125 characters without any length.

The reason why such a check isn't added, is that I believed (and still believe) that consistency is more important than strictly following the code conventions. And you can get this consistency by using a code formatter in your IDE. Enabling this formatter for every save action (and/or applying formatter just before submitting) will result in consistent code formatting. No test case needed.

[Joel Mata]

Just a note.

Is was receiving these multiple errors...

    [javac] /Users/guybrushtreepwood/Downloads/workspace/URLyBird/src/TestJarSubmission.java:3: package org.junit does not exist
    [javac] import org.junit.Assert;
    [javac]                 ^
    [javac] /Users/guybrushtreepwood/Downloads/workspace/URLyBird/src/TestJarSubmission.java:4: package org.junit does not exist
    [javac] import org.junit.Test;
    [javac]                 ^
…
    [javac] /Users/guybrushtreepwood/Downloads/workspace/URLyBird/src/TestJarSubmission.java:220: cannot find symbol
    [javac] symbol  : variable Assert
    [javac] location: class TestJarSubmission
    [javac]                 Assert.fail("constructor not found");  
    [javac]                 ^
    [javac] 18 errors

in order to solve this i had to:
1) create a lib folder
2) download and save in 1) the junit4 jar
3) edit the ant build properties (right click, "Ant Debug Build…", and edit the class path in order to add the file 2)

Hope it helps.