cs101-F2019-lab8-starter

Table of Contents

• Table of Contents
• Introduction
• Continuous Learning
• System Commands
  • Using Docker
  • Using Gradle
• Expected Program Output
• Automated Checks with GatorGrader
• Downloading Project Updates
• Using Travis CI
• System Requirements
• Reporting Problems
• Receiving Assistance
• Project Assessment

Introduction

Designed for use with GitHub Classroom and GatorGrader, this repository contains the starter for a laboratory assignment in an introductory computer science class that uses the Java programming language. The Travis CI builds for this repository will pass, as evidenced by a red ✗ instead of a green ✔ appearing in the commit logs. An instructor would use this repository to create a "starter" repository with purposefully omitted features that a student would then need to add in order to achieve the stated learning objectives. Please bear in mind that much of the content in this document is written in its current form under the assumption that it will also accompany the "starter" repository that an instructor shares with a student through the use of GitHub Classroom.

This assignment requires a programmer to implement and test a benchmarking framework that supports the empirical evaluation of the SinglyLinkedList's method that produces a textual representation of its contained data. More details about the purpose and implementation of the SinglyLinkedList are available in Section 3.2 of the textbook. You can learn about experimental studies by reviewing the content in Sections 4.1 through 4.3. Also, you can learn more about iterative algorithms by reviewing Section 1.5.2. Please note that this assignment will also require you to read and use Java classes that contain a test suite. Specifically, the programmer is responsible for learning how to run and extend a test suite written in the JUnit testing framework, as explained in Section 1.9. As verified by Checkstyle, the source code for all of the Java classes must adhere to all of the requirements in the Google Java Style Guide.

The programmer completing this assignment is also responsible for writing a multiple-paragraph reflection, stored in the file writing/reflection.md, that explains the challenges that you faced and the solutions you developed. This is a Markdown file that should adhere to the standards described in the Markdown Syntax Guide. Remember, an individual completing this assignment can preview the contents of a comitted Markdown file by clicking on the name of the file in your GitHub repository. Don't forget that your writing/reflection.md file should adhere to the Markdown standards established by the Markdown linting tool and, optionally, the writing standards set by the Proselint tool.

A carefully formatted assignment sheet for this project provides more details about the steps that a computer scientist should take to complete this assignment. You can view this assignment sheet by visiting the listing of laboratories on the course web site created by the course instructor. Please pay attention to the icons in the left-hand margin of the assignment sheet as they will help you to understand and remember what steps you should take at key parts of the assignment.

Continuous Learning

If you have not done so already, please read all of the relevant GitHub Guides that explain how to use many of the features that GitHub provides. In particular, please make sure that you have read the following GitHub guides: Mastering Markdown, Hello World, and Documenting Your Projects on GitHub. Each of these guides will help you to understand how to use both GitHub and GitHub Classroom.

Students who want to learn more about how to use Docker should review the Docker Documentation. Students are also encouraged to review the documentation for their text editor, which is available for text editors like Atom and VS Code. You should also review the Git documentation to learn more about how to use the Git command-line client. In addition to talking with the instructor and technical leader for your course, students are encouraged to search StackOverflow for answers to their technical questions.

To do well on this assignment, you should also read Section 1.5.2 to learn more about iteration constructs. You should further review Sections 4.1 to 4.3, focusing on the content that explains the steps of both an analytical and an empirical evaluation of an algorithm. Please read all of the content and study all of the technical diagrams and source code segments in Section 3.2. Finally, please see the course instructor or one of the teaching assistants or tutors if you have questions about any of these reading assignments.

System Commands

This project invites students to enter system commands into a terminal window. This assignment uses Docker to deliver programs, such as gradle and the source code and packages needed to run GatorGrader, to a students' computer, thereby eliminating the need for a programmer to install them on their development workstation. Individuals who do not want to install Docker can optionally install of the programs mentioned in the Project Requirements section of this document.

Using Docker

Once you have installed Docker Desktop, you can use the following docker run command to start gradle grade as a containerized application, using the DockaGator Docker image available on DockerHub.

docker run --rm --name dockagator \
  -v "$(pwd)":/project \
  -v "$HOME/.dockagator":/root/.local/share \
  gatoreducator/dockagator

The aforementioned command will use "$(pwd)" (i.e., the current directory) as the project directory and "$HOME/.dockagator" as the cached GatorGrader directory. Please note that both of these directories must exist, although only the project directory must contain something. Generally, the project directory should contain the source code and technical writing of this assignment, as provided to a student through GitHub. Additionally, the cache directory should not contain anything other than directories and programs created by DockaGator, thus ensuring that they are not otherwise overwritten during the completion of the assignment. To ensure that the previous command will work correctly, you should create the cache directory by running the command mkdir $HOME/.dockagator. If the above docker run command does not work correctly on the Windows operating system, you may need to instead run the following command to work around limitations in the terminal window:

docker run --rm --name dockagator \
  -v "$(pwd):/project" \
  -v "$HOME/.dockagator:/root/.local/share" \
  gatoreducator/dockagator

If that Docker command does not work correctly, then you should first consider writing the command on a single line in your terminal window and then replacing $(pwd) and $HOME with the fully qualified name of the directory that those variables represent. Students who are stuck on this step should explain to the course instructor what they have already tried and what challenges they currently face.

Here are some additional commands that you may need to run when using Docker:

• docker info: display information about how Docker runs on your workstation
• docker images: show the Docker images installed on your workstation
• docker container list: list the active images running on your workstation
• docker system prune: remove many types of "dangling" components from your workstation
• docker image prune: remove all "dangling" docker images from your workstation
• docker container prune: remove all stopped docker containers from your workstation
• docker rmi $(docker images -q) --force: remove all docker images from your workstation

Using Gradle

Since the above docker run command uses a Docker image that, by default, runs gradle grade and then exits the Docker container, you may want to instead run the following command so that you enter an "interactive terminal" that will allow you to repeatedly run commands within the Docker container.

docker run -it --rm --name dockagator \
  -v "$(pwd)":/project \
  -v "$HOME/.dockagator":/root/.local/share \
  gatoreducator/dockagator /bin/bash

Once you have typed this command, you can use the GatorGrader tool in the Docker container by typing the command gradle grade in your terminal. Running this command will produce a lot of output that you should carefully inspect. If GatorGrader's output shows that there are no mistakes in the assignment, then your source code and writing are passing all of the automated baseline checks. However, if the output indicates that there are mistakes, then you will need to understand what they are and then try to fix them.

You can also complete several important Java programming tasks by using the gradle tool. For instance, you can compile (i.e., create bytecode from the program's source code if it is correct) the program using the command gradle build. Here are some other commands that you can type:

• gradle grade: run the GatorGrader tool to check your work
• gradle clean: clean the project of all the derived files
• gradle check: check the quality of the code using Checkstyle
• gradle build: create the bytecode from the Java source code
• gradle run: run the Java program in the command-line
• gradle cleanTest: clean the JUnit test suite of derived files
• gradle test: run the JUnit test suite and display the results
• gradle tasks: display details about the Gradle system

To run one of these commands, you must be in the main (i.e., "home base") directory for this assignment where the build.gradle file is located.

Expected Program Output

Typing the command gradle run in the terminal window should produce the following output for the completed version of Experiment. As long as your program adheres to all of the requirements for the assignment and passes all of the verification checks, your version should produce similar output. With that said, program output may vary according to, for instance, the name of the programmer and the date on which you ran the program.

> Configure project :
Configured GatorGradle 0.4.4

> Task :run
Starting a campaign of experiments with toString ...
  Running round 0 with input size 10
  Running round 1 with input size 20
  Running round 2 with input size 40
  Running round 3 with input size 80
  Running round 4 with input size 160
  Running round 5 with input size 320
  Running round 6 with input size 640
  Running round 7 with input size 1280
  Running round 8 with input size 2560
  Running round 9 with input size 5120
  Running round 10 with input size 10240
  Running round 11 with input size 20480
  Running round 12 with input size 40960
  Running round 13 with input size 81920
  Running round 14 with input size 163840
  Running round 15 with input size 327680
  Running round 16 with input size 655360
  Running round 17 with input size 1310720
  Running round 18 with input size 2621440
  Running round 19 with input size 5242880
... Finishing a campaign of experiments with toString

Results of an experiment campaign with toString
Size (#)        Timing (ms)     Ratio (#)
10              0               0
20              0               0
40              0               0
80              0               0
160             0               0
320             0               0
640             1               0
1280            0               0
2560            1               0
5120            2               2
10240           3               2
20480           4               1
40960           6               2
81920           10              2
163840          6               1
327680          10              2
655360          22              2
1310720         46              2
2621440         141             3
5242880         4725            34

Automated Checks with GatorGrader

In addition to meeting all of the requirements outlined in the assignment sheet, your submission must pass the following checks that GatorGrader automatically assesses:

• The Campaign.java in src/main/java/labeight/experiment has exactly 0 of the Add Your Name Here fragment
• The Campaign.java in src/main/java/labeight/experiment has exactly 0 of the TODO fragment
• The Campaign.java in src/main/java/labeight/experiment has exactly 0 of the println fragment
• The Campaign.java in src/main/java/labeight/experiment has exactly 1 of the package labeight fragment
• The Experiment.java in src/main/java/labeight/experiment has at least 2 single-line Java comment(s)
• The Experiment.java in src/main/java/labeight/experiment has at least 4 multiple-line Java comment(s)
• The Experiment.java in src/main/java/labeight/experiment has at least 4 of the println( fragment
• The Experiment.java in src/main/java/labeight/experiment has exactly 0 of the Add Your Name Here fragment
• The Experiment.java in src/main/java/labeight/experiment has exactly 0 of the TODO fragment
• The Experiment.java in src/main/java/labeight/experiment has exactly 1 of the package labeight fragment
• The ResultsTable.java in src/main/java/labeight/data has at least 12 multiple-line Java comment(s)
• The ResultsTable.java in src/main/java/labeight/data has at least 2 single-line Java comment(s)
• The ResultsTable.java in src/main/java/labeight/data has exactly 0 of the Add Your Name Here fragment
• The ResultsTable.java in src/main/java/labeight/data has exactly 0 of the TODO fragment
• The ResultsTable.java in src/main/java/labeight/data has exactly 0 of the println fragment
• The ResultsTable.java in src/main/java/labeight/data has exactly 1 of the double ratio = fragment
• The ResultsTable.java in src/main/java/labeight/data has exactly 1 of the package labeight fragment
• The RunCampaign.java in src/main/java/labeight/experiment has at least 1 single-line Java comment(s)
• The RunCampaign.java in src/main/java/labeight/experiment has at least 3 of the println( fragment
• The RunCampaign.java in src/main/java/labeight/experiment has at least 5 multiple-line Java comment(s)
• The RunCampaign.java in src/main/java/labeight/experiment has exactly 0 of the Add Your Name Here fragment
• The RunCampaign.java in src/main/java/labeight/experiment has exactly 0 of the TODO fragment
• The RunCampaign.java in src/main/java/labeight/experiment has exactly 1 of the package labeight fragment
• The SinglyLinkedList.java in src/main/java/labeight/list has exactly 0 of the Add Your Name Here fragment
• The SinglyLinkedList.java in src/main/java/labeight/list has exactly 0 of the TODO fragment
• The SinglyLinkedList.java in src/main/java/labeight/list has exactly 0 of the public abstract class fragment
• The SinglyLinkedList.java in src/main/java/labeight/list has exactly 1 of the package labeight fragment
• The SinglyLinkedList.java in src/main/java/labeight/list has exactly 1 of the public String toString( fragment
• The TestResultsTable.java in src/test/java/labeight has exactly 0 of the Add Your Name Here fragment
• The TestResultsTable.java in src/test/java/labeight has exactly 0 of the TODO fragment
• The TestResultsTable.java in src/test/java/labeight has exactly 1 of the package labeight fragment
• The command gradle -q --console plain run executes correctly
• The command gradle build executes correctly
• The command gradle test executes correctly
• The file Campaign.java exists in the src/main/java/labeight/experiment directory
• The file Experiment.java exists in the src/main/java/labeight/experiment directory
• The file ResultsTable.java exists in the src/main/java/labeight/data directory
• The file RunCampaign.java exists in the src/main/java/labeight/experiment directory
• The file SinglyLinkedList.java exists in the src/main/java/labeight/list directory
• The file TestResultsTable.java exists in the src/test/java/labeight directory
• The file reflection.md exists in the writing directory
• The reflection.md in writing has at least 5 of the code tag
• The reflection.md in writing has at least 800 word(s) in total
• The reflection.md in writing has at least 9 paragraph(s)
• The reflection.md in writing has exactly 0 of the Add Your Name Here fragment
• The reflection.md in writing has exactly 12 of the heading tag
• The reflection.md in writing has exactly 2 of the code_block tag
• The repository has at least 10 commit(s)

If GatorGrader's automated checks pass correctly, the tool will produce the output like the following in addition to returning a zero exit code (which you can access by typing the command echo $?).

        ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
        ┃ Passed 48/48 (100%) of checks for cs101-F2019-lab8! ┃
        ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

Downloading Project Updates

If GatorGrader's maintainers push updates to this sample assignment and you received it through GitHub Classroom and you would like to also receive these updates, then you can type this command in the main directory for this assignment:

git remote add download [email protected]:Allegheny-Computer-Science-101-F2019/cs101-F2019-lab8-starter.git

You should only need to type this command once; running the command additional times may yield an error message but will not negatively influence the state of your Git repository. Now, you are ready to download the updates provided by the GatorGrader maintainers by typing this command:

git pull download master

This second command can be run whenever the maintainers needs to provide you with new source code for this assignment. However, please note that, if you have edited the files that we updated, running the previous command may lead to Git merge conflicts. If this happens, you may need to manually resolve them with the help of the instructor or a student technical leader. Finally, please note that the Gradle plugin for GatorGrader will automatically download the newest version of GatorGrader.

Using Travis CI

This assignment uses Travis CI to automatically run GatorGrader and additional checking programs every time you commit to your GitHub repository. The checking will start as soon as you have accepted the assignment — thus creating your own private repository — and the course instructor and/or GitHub enables Travis for it. If you are using Travis for the first time, you will need to authorize Travis CI to access the private repositories that you created on GitHub. If you do not see either a yellow ● or a green ✔ or a red ✗ in your listing of commits, then please ask the instructor to see whether or not Travis CI was correctly enabled.

System Requirements

We developed this assignment to work with the following software and versions:

• Docker Desktop
• Operating Systems
  • Linux
  • MacOS
  • Windows 10 Pro
  • Windows 10 Enterprise
• Programming Language Tools
  • Gradle 5.4
  • MDL 0.5.0
  • OpenJDK 11.0.4
  • JUnit 4.9.0
  • Proselint 0.10.2
  • Python 3.6 or 3.7

Reporting Problems

If you have found a problem with this assignment's provided source code or documentation, then you can go to the Computer Science 101 Fall 2019 Lab 5 repository and raise an issue. If you have found a problem with the GatorGrader tool and the way that it checks your assignment, then you can also raise an issue in that repository. To ensure that your issue is properly resolved, please provide as many details as is possible about the problem that you experienced. If you discover a problem with the assignment sheet for this project, then please raise an issue in the GitHub repository that provides the assignment sheets for your course.

Whenever possible, individuals who find, and use the appropriate GitHub issue tracker to correctly document, a mistake in any aspect of this assignment will receive free GitHub stickers and extra credit towards their grade for the project.

Receiving Assistance

If you are having trouble completing any part of this project, then please talk with either the course instructor or a student technical leader during the course session. Alternatively, you may ask questions in the Slack workspace for this course. Finally, you can schedule a meeting during the course instructor's office hours.

Project Assessment

Taking inspiration from the principles of specification-based grading, the grade that a student receives on this assignment will have the following components:

• Percentage of Correct GatorGrader Checks: Students are encouraged to repeatedly try to implement a Java program that passes all of GatorGrader's checks by, for instance, creating a program that produces the correct output. Students should also repeatedly revise their technical writing to ensure that it also passes all of GatorGrader's checks about, for instance, the length of its content and its appropriate use of Markdown.

• Travis CI Build Status: Since additional checks on the source code and/or technical writing may be encoded in Travis CI's actions and, moreover, all of the GatorGrader checks are also run in Travis CI, students will receive a checkmark grade if their last before-the-deadline build passes and a green ✔ appears in their GitHub commit log instead of a red ✗. As with the previous grading component, students are encouraged to repeatedly revise their source code and technical writing in an attempt to get their Travis CI build to pass.

• Mastery of Technical Writing: Students will also receive a checkmark grade when the responses to the technical writing questions presented in the writing/reflection.md reveal a mastery of both writing skills and technical knowledge. To receive a checkmark grade, the submitted writing should have correct spelling, grammar, and punctuation in addition to following the rules of Markdown and providing technically accurate answers. Students are encouraged to ask the course instructor or a student technical leader to use the GitHub issue tracker to provide feedback on their mastery of technical writing skills.

• Mastery of Technical Knowledge and Skills: Students will receive also receive a checkmark grade when their GitHub repository reveals that they have mastered all of the technical knowledge and skills developed during the completion of this project. As a part of this grade, the instructor will assess aspects of the project including, but not limited to, the use of effective source code comments and Git commit messages. Students are encouraged to ask the course instructor or a student technical leader to use the GitHub issue tracker to provide feedback on how well their work demonstrates mastery of the assignment's technical knowledge and skills.

All grades for this project will be reported through a student's GitHub repository using either messages in the GitHub commit log or issues raised in the issue tracker. Students should ask questions about their grade for this project in GitHub so as to facilitate an effective conversation about the submitted deliverables.