AB-1 is still using JDK9 and support for JDK9 from Oracle is no longer available.

The current one is tied to the semester http://www.comp.nus.edu.sg/~cs2103/AY1617S1/contents/coding-standards-java.html

In README.md

The code violates several checkstyle rules.

A brief description of file format, internal data format etc.

Similar to runtests.bat but for Unix based users

The current ToC has level 1 headings only. We can add one more level of topics to it.

User guide for changing of the save location needs to be updated to the new implementation

Subject of the Issue

runtests.bat reports file access errors when the case sensitive attribute of \src or \test directories is enabled.

There are two related sub-problems discovered:

1. Typographical error in runtests.bat:10 resulting in javac reporting a "file not found" error.
   javac ..\src\seedu\addressbook\Addressbook.java -d ..\bin should have been:
   javac ..\src\seedu\addressbook\AddressBook.java -d ..\bin
2. fc file compare utility tool shipped with Windows (used in runtests.bat:35 - FC actual.txt expected.txt) is unable to access files residing in directories with case sensitive attribute enabled

This unintentional bug was likely introduced with the release of Windows 10 Redstone 4 Insider Build 17093, as the case sensitive attribute for directories was first introduced in this particular Windows 10 Insider Build (eventually released in Windows 10 Redstone 4 officially as well).

Tested on Environment(s)

• Fully updated Windows 10 Version 1803 (April 2018 Update) a.k.a. Windows 10 Redstone 4
• Fully updated Windows 10 Version 1809 (October 2018 Update) a.k.a. Windows 10 Redstone 5
• WSL installed and enabled (required to reproduce this bug)
• Oracle JDK 9.0.4

Sub-problem 1: javac reporting a "file not found" error

Steps to Reproduce

1. Ensure that WSL optional feature is installed and enabled by running the following command in PowerShell as Administrator:

Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

2. Restart the computer when prompted
3. Ensure that case sensitive attribute is enabled in \src directory:

C:\[REDACTED]\addressbook-level1>fsutil file setCaseSensitiveInfo .\src enable
Case sensitive attribute on directory C:\[REDACTED]\addressbook-level1\src is enabled.

4. Execute runtests.bat

Expected Behaviour

No errors when running runtests.bat.

In \test directory:

C:\[REDACTED]\addressbook-level1\test>runtests.bat
        1 file(s) copied.

C:\[REDACTED]\addressbook-level1\test>echo %ERRORLEVEL%
0

Outside \test directory:

C:\[REDACTED]\addressbook-level1>test\runtests.bat
        1 file(s) copied.

C:\[REDACTED]\addressbook-level1>echo %ERRORLEVEL%
0

Actual Behaviour

When running runtests.bat, javac reports a "file not found" error.

In \test directory:

C:\[REDACTED]\addressbook-level1\test>runtests.bat
javac: file not found: ..\src\seedu\addressbook\Addressbook.java
Usage: javac <options> <source files>
use --help for a list of possible options
********** BUILD FAILURE **********

C:\[REDACTED]\addressbook-level1\test>echo %ERRORLEVEL%
1

Outside \test directory:

C:\[REDACTED]\addressbook-level1>test\runtests.bat
javac: file not found: ..\src\seedu\addressbook\Addressbook.java
Usage: javac <options> <source files>
use --help for a list of possible options
********** BUILD FAILURE **********

C:\[REDACTED]\addressbook-level1>echo %ERRORLEVEL%
1

Suggested Fix:

Simply replace javac ..\src\seedu\addressbook\Addressbook.java -d ..\bin found at runtests.bat:10 with javac ..\src\seedu\addressbook\AddressBook.java -d ..\bin.

Sub-problem 2: fc reporting a "no such file or folder" error

Steps to Reproduce

1. Ensure that WSL optional feature is installed and enabled by running the following command in PowerShell as Administrator:

Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

2. Restart the computer when prompted
3. Ensure that case sensitive attribute is enabled in \test directory:

C:\[REDACTED]\addressbook-level1>fsutil file setCaseSensitiveInfo .\test enable
Case sensitive attribute on directory C:\[REDACTED]\addressbook-level1\test is enabled.

4. Fix the typographical error in runtests.bat:10 by replacing the affected line with:
   javac ..\src\seedu\addressbook\AddressBook.java -d ..\bin
5. Execute runtests.bat

Expected Behaviour

No errors when running runtests.bat.

In \test directory:

C:\[REDACTED]\addressbook-level1\test>runtests.bat
        1 file(s) copied.

C:\[REDACTED]\addressbook-level1\test>echo %ERRORLEVEL%
0

Outside \test directory:

C:\[REDACTED]\addressbook-level1>test\runtests.bat
        1 file(s) copied.

C:\[REDACTED]\addressbook-level1>echo %ERRORLEVEL%
0

Actual Behaviour

When running runtests.bat, fc reports a "no such file or folder" error.

In \test directory:

C:\[REDACTED]\addressbook-level1\test>runtests.bat
        1 file(s) copied.
FC: cannot open ACTUAL.TXT - No such file or folder

C:\[REDACTED]\addressbook-level1>echo %ERRORLEVEL%
2

Outside \test directory:

C:\[REDACTED]\addressbook-level1>test\runtests.bat
        1 file(s) copied.
FC: cannot open ACTUAL.TXT - No such file or folder

C:\[REDACTED]\addressbook-level1>echo %ERRORLEVEL%
2

Suggested Fix:

Due to the way how the fc file compare Windows utility tool parses and transforms filepaths internally, one possible fix for this problem is to disable the case sensitivity attribute of \test directory, unless Microsoft fixes the way how the fc tool parses and interprets filepaths.

Referring to isValidFilePath(String filePath)

Add a learning outcome for java Optional feature

Current docs are written for Eclipse. Convert them to use Intellij.

As we have moved to IntelliJ, the Eclipse project files are no longer needed.

Let's remove these files/folders:

• .classpath
• .project
• .settings/*
• docs/*.pptx

The sections in concern can point to the same sections in se-edu, rather than duplicate here.
Make sure all the names here are listed in se-edu page as well.

Contents of LO section will be superseded by the text book. Can be removed.

If the bin folder is missing, the script can create it first.

Ensure that this project works with Java 9. Even better if we can have both Java 9 and 10 compatibility.

The first test run always fail - encountered difference between actual.txt and expected.txt. This happened due to the default storage file was not provided, hence the program has to generate a new one on its first run.

Let's include a default file, addressbook.txt, in the test folder so that the runtests.bat does not fail on the first run.

I don't understand how to test with the text files? I implicated the to do's and tried to push but it didn't work. I'm not sure what I'm doing wrong. The error says

git -c diff.mnemonicprefix=false -c core.quotepath=false --no-optional-locks push -v --tags origin master:master
remote: Permission to nus-cs2103-AY1819S2/addressbook-level1.git denied to PhilipPhil.
fatal: unable to access 'https://github.com/nus-cs2103-AY1819S2/addressbook-level1.git/': The requested URL returned error: 403

Pushing to https://github.com/nus-cs2103-AY1819S2/addressbook-level1.git
Completed with errors, see above.

The readme specifies the same outcome twice in a row:

Note: this exercise covers two other Learning Outcomes: [LO-CodingBestPractices], [LO-CodingBestPractices]

Exit status of javac not checked. Script continues to run even if javac fails.
This is the same behaviour for runtests.bat.

Location: https://github.com/se-edu/addressbook-level1/blob/master/docs/LearningOutcomes.adoc#exercise-setup-project-in-intellij

Problem: it says 'link above' but the link actually appears in a different page.

Suggested: change to 'link in the project homepage' and give the correct link.

User cannot run tests/runtests.bat if current directory is not tests.

/cc @damithc

Currently it refers to a pdf file in the module web site

Clicking "in this document" returns Error 404: Not Found

Apply coding best practices [LO-CodingBestPractices]

Most of the given code follows the best practices mentioned in this document.

This learning outcome is covered by the exercise in [LO-Refactor]

Also at this part:

Fix violations of the best practices given in in this document.