Assignment 1 Passwords

CMSC204
Assignment 1
Passwords

Concepts tested by this program:
    ArrayList
    static
    Read  Files
    Javadoc
    JUnit Tests
    Exceptions

Create an application that will check for valid passwords.  The following rules must be followed to create a valid password.
1.    At least 6 characters long
2.    10 or more characters is a strong password, between 6 and 9 characters is a weak (but acceptable) password.
3.    At least 1 numeric character
4.    At least 1 uppercase alphabetic character
5.    At least 1 lowercase alphabetic character
6.    At least 1 special character
7.    No more than 2 of the same character in a sequence
Hello@123 – OK
AAAbb@123 – not OK
Aaabb@123 – OK

Operation:
When the application begins, the user will be presented with a screen that states the above instructions for creating a password, two text entry boxes for typing in a password, and three buttons.  
If the user wants to check a single password, they will type in the password in both boxes and select the “Check Password” button.
If the user wants to read in and check a list of passwords, they will select the “Check Passwords in File” button, be presented with a file explorer, and select the file to read from.  Those passwords that failed the check will be displayed, with their error message.
Specifications:
The Data Element
String
The Data Structure
ArrayList of Strings
Utility Class
1.    Create a PasswordCheckerUtility class based on the Javadoc given you.  
2.    The PasswordCheckerUtility class will have at least three public methods:  
•    isValidPassword:
This method will check the validity of one password and return true if the password is valid and throw one or more exceptions if invalid.  (Refer to java doc for the list of the exceptions thrown)
•    isWeakPassword:
Checks if password is valid and the length is NOT between 6 -9 characters. It returns false if the password is valid and the length of password  is NOT  between 6 and 9 (inclusive) and throws WeakPasswordException otherwise. 
•    getInvalidPasswords
This method will accept an ArrayList of passwords as the parameter  and return an ArrayList with the status of any invalid passwords (weak passwords are not considered invalid).  The ArrayList of invalid passwords will be of the following format:
<password><blank><message of exception thrown>
•    For each password requirement, you must have a static private method that validates the password for that requirement and throws an exception if invalid. Refer to the provided JavaDoc file for the complete list of required methods.
3.    Create a separate exception classes for each exception listed in PasswordCheckerUtility Javadoc. Refer to Exceptions section for specific messages for each Exception class.
Hints:
•    The GUI will check for the length of the password first, since that is the easiest and fastest check.  Once the password fails one rule, there is no need to check the rest of the rules.
•    To check for a special symbol, use the “regular expression” construct.  Check the whole password, not just an individual character, using the following :
        Pattern pattern = Pattern.compile("[a-zA-Z0-9]*");
        Matcher matcher = pattern.matcher(str);
        return (!matcher.matches());
•    You will need to import Pattern and Matcher.
•    Few helpful links on regular expression”
•    https://www.vogella.com/tutorials/JavaRegularExpressions/article.html
•    https://www.youtube.com/watch?v=rhzKDrUiJVk
•    https://www.youtube.com/watch?v=sCuOJ8uadOg

The GUI (provided):
The GUI has been provided, however you need to:
•    The GUI will ask the user to enter the password and to re-type the password.  If the two are not the same, inform the user.
•    Use methods of PasswordCheckerUtility to check validity of one password when user clicks on “Check Password” button.
•    Use methods of PasswordCheckerUtility to check validity of a file of passwords when user clicks on “Check Passwords in File” button.
•    Use a FileChooser for the user to select the input file.
•    Use try/catch structure to catch exceptions thrown by PasswordCheckerUtility methods

Exceptions
Provide exception classes for the following:
1.    Length of password is less than 6 characters (class LengthException)
Message – The password must be at least 6 characters long
2.    Password doesn’t contain an uppercase alpha character (class NoUpperAlphaException)
Message – The password must contain at least one uppercase alphabetic character
3.    Password doesn’t contain a lowercase alpha character (class NoLowerAlphaException)
Message – The password must contain at least one lowercase alphabetic character
4.    Password doesn’t contain a numeric character (class NoDigitException)
Message – The password must contain at least one digit
5.    Password doesn’t contain a special character (class NoSpecialCharacterException)
Message – The password must contain at least one special character 
6.    Password contains more than 2 of the same character in sequence (class InvalidSequenceException)
Message – The password cannot contain more than two of the same character in sequence.
7.    Password contains 6 to 9 characters which are otherwise valid (class WeakPasswordException)
Message – The password is OK but weak - it contains fewer than 10 characters.
8.    For GUI – check if Password and re-typed Password are identical (class UnmatchedException) 
Message – The passwords do not match
Throw this exception from the GUI, not the utility class.

Note: If more than one error is present in a password, use the above order to throw exceptions.  For example, if a password is “xxyyzzwwaa$”, it fails rules 2 and 4 above.  Throw a NoUpperAlphaException, not a NoDigitException.

Student Junit methods:
•    Use the file PasswordCheckerUtility.java
•    Setup: include passwords that meet the below criteria.
•    Teardown: set your student passwords ArrayList to null
•    for each password requirement method in the PasswordCheckerUtility you must have a test case that passes and another one that fails

When you launch the GUI, this is what you will see.

 
If you select the button which reads “Check Passwords in File”, you will be presented with a file chooser.  You must navigate to where you stored the file “passwords.txt” and load it.  The file will be in the following format (one password per line):
 

 
Examples:

 

1.    No lowercase alphabetic character


 


Displayed to user:
 

 
2.    No digit

 



Displayed to user:
 





3.    If the password is OK, but between 6 and 10 characters, you will see:
 

4.    If password has more than two of the same characters in a row
 

Displayed to user:
 



 
5.    If password is valid

 




 
6.    If the passwords do not match:

 


Displayed to user:
 
 

6.  Based on the file above, when the user selects “Check Passwords in File”:

Displays errors to user when selecting Check Passwords in File. Note that valid passwords (including weak but otherwise valid passwords) are NOT displayed.
  

 


Deliverables
Note: ONLY SUBMIT THE FILES THAT YOU IMPLEMENTED OR UPDATED. YOU DO NOT NEED TO SUBMIT THE FILES THAT ARE ALREADY PROVIDED FOR YOU.


Design:
      Initial design document (UML and/or pseudo-code)

Implementation:
      Final design document
      Java files - The src folder with your driver (javafx application), data manager, exceptions and Junit Test (.java) files
Javadoc files - The entire doc folder with your javadoc for student generated files
Learning Experience document
GitHub screen shot

Deliverable format: The above deliverables will be packaged as follows. Two compressed files in the following formats:
LastNameFirstName_AssignmentX.zip [compressed file containing following]:
doc [a directory] include the entire doc folder with the javadoc for 
student generated files
            file1.html (example)
            file2.html (example)
            class-use (example directory)
        LearningExperience.doc or other text format
src [a directory] contains your driver (javafx application), data manager, exceptions and Junit Test (.java) files
            File1.java (example)
            File2.java (example)
            File_Test.java (example)
        GitHub screen shot.
LastNameFirstName_AssignmentX_Moss.zip [compressed file containing only]:
.java file which includes the driver (javafx application), data manager, exceptions and Junit Test (.java) files – NO 
FOLDERS!!
        File1.java (example)
        File2.java (example)









Grading Rubric
CMSC 204 Project #1
Name _____________________________    
   
Overview: 
There are two parts to the rubric.   First, the project is graded on whether it passes public and private tests.  If it does not compile, a 0 will be given. These points add up to 100.  Second, the score is decremented if various requirements are not met, e.g., missing required methods, missing Junit test cases, no Javadoc, no UML diagram, uses constructs that are not allowed, etc.

TESTING    (100 pts)                
     Compiles                                        35 pts _____
     Student Junit required student tests                        8 pts _____

     Passes JUnit student tests                                7 pts _____
     Passes public JUnit tests                                  15 pts _____
     Passes private instructor tests                           15 pts _____
     Execution: runs without errors (either run-time or logic errors           20 pts _____
Possible Sub-total                            100 pts _____ 


REQUIREMENTS  (Subtracts from Testing total)

Documentation: 
     Javadoc for student generated files not submitted (entire doc folder)        -5 pts _____
     Documentation within source code was missing or incorrect        -1.5 pts _____
    Description of what class does was missing                            
    Author’s Name, @author, was missing                      
         Methods not commented properly using Javadoc @param, @return
     JUnit STUDENT methods were not implemented                -10 pts _____
      Screen shot of GitHub repo with Assignment1 files was not submitted     -5 pts _____
     MOSS files were not submitted                             -5 pts _____
     Learning Experience                                   -2.5 pts _____
    In 3+ paragraphs, highlight your lessons learned and learning experience from working on this project.  What have you learned? What did you struggle with? What would you do differently on your next project?

Programming Style:
     Incorrect use of indentation, statements, structures              -2 pts _____

Design:
     Implementation does not follow final design                                              -4 pts _____

     Classes do not have the functionality specified, i.e.,
1.     PasswordCheckerUtility class                      -10 pts _____
does not have a method to check validity of password        
does not have a method to check validity of  ArrayList of passwords
does not follow the Javadoc provided      
does not have private method for each password requirement
2.    GUI does not compile                          -5 pts _____    
3.    Exceptions  classes                              -10 pts _____
does not have exception class for each invalid password rule
does not have exception class for weak password            
does not have exception class if password and re-type password don’t match 
does not have exception class for each password requirement
Possible decrements:                             -60 pts _____
Possible total grade:                                    100 pts _____