Udacity Java Web Developer Nanodegree Project 1 - Live demo
This project is an exercise to acquaint the developer with Spring, Spring Boot, Thymeleaf the Spring Initializer, the MyBatis ORM (Object-Relational Mapping) framework, the JUnit 5 testing framework, the Selenium WebDriver for integration testing and the IntelliJ IDE.
The project's rubric requires the developer to create a website on the Spring Framework that provides authenticated access and allows a user to save a list of files, notes, and website credentials on a server. The developer must create:
- The back-end with Spring Boot
- The front-end with Thymeleaf
- Application tests with Selenium
The instructors provide the student developer with front-end html files, a hashing service class, an encryption service class and a Spring Boot framework using Maven.
The project requires IntelliJ IDE and has only tested in that development environment. The Maven project file (pom.xml) provides all dependencies. The main() method is found in:
cloudstorage/src/main/java/com/udacity/jwdnd/course1/cloudstorage/CloudStorageApplication.java
Integration tests on Chrome can be found here:
cloudstorage/src/test/java/com/udacity/jwdnd/course1/cloudstorage/CloudStorageApplicationTests.java
There are also JUnit tests for the model layer. They can be found in the cloudstorage/src/test/java/com/udacity/jwdnd/course1/cloudstorage/model/ package.
I did a lot of reading and reseach for this project after being away from Java, Java Servlets and JUnit testing for a long time. I want to thank all the developers and educators who generously posted documentation, solutions and tutorials online.
- multiple topics including Resources, ResourceLoader and JUnit Testing.
- Multiple topics including Waits
- Using @Resource, @Autowired in Junit test - https://www.baeldung.com/spring-annotations-resource-inject-autowire
- Guide to JUnit 5 Parameterized
- Serve Static Resources with Spring
- Assert an Exception
- Quick Guide to MyBatis
- Testing in SpringBoot
- Custom Errors
- Configure Tomcat
- Java Read Files https://www.w3schools.com/java/java_files_read.asp
- SQL Syntax - https://www.w3schools.com/sql/sql_insert.asp
- Java Exceptions - https://www.w3schools.com/java/java_try_catch.asp
- ... and more html tags & attirbutes references, Java syntax and Bootstrap Modals.
Contributors of Answers at Stack Overflow
- Michael Pollmeier: Reading bytes from a file - https://stackoverflow.com/questions/858980/file-to-byte-in-java
- Chirs Mowforth: Getting a file's mime type - https://stackoverflow.com/questions/51438/getting-a-files-mime-type-in-java
- bmargulies: writing files - https://stackoverflow.com/questions/4350084/byte-to-file-in-java
- lorinpa: Test Context Configuration - https://stackoverflow.com/questions/21414750/spring-mvc-junit-test-applicationcontext-config#21414920
- dubbe: Twitter Bootstrap Tabs - https://bit.ly/2FSND7O
- dubbe: Using AJAX in Javascript to load response into the browser : https://bit.ly/2FSND7O
- Maarten Bodewes - isBlank() vs isEmpty() - https://stackoverflow.com/questions/23419087/stringutils-isblank-vs-string-isempty
- Moritz Petersen - Conver byte array to download file - https://stackoverflow.com/questions/13989215/how-to-convert-a-byte-into-a-file-with-a-download-dialog-box
- Christopher Bales - inserting a string into an HTML Input element - https://stackoverflow.com/questions/7331146/how-to-get-text-of-single-input-tag
- Hari Reddy - Correct way to focus on elements using Selenium WebDriver - https://stackoverflow.com/questions/11337353/correct-way-to-focus-an-element-in-selenium-webdriver-using-java
- Stephen C - Invalid AES Key Length - https://stackoverflow.com/questions/63990329/invalid-aes-key-length-12-bytes-in-java
- Nthalk - How to Pad a string in Java - https://stackoverflow.com/questions/388461/how-can-i-pad-a-string-in-java
Contributors to StackExchange
- Chris Liston - Selenium Waits - https://sqa.stackexchange.com/questions/39348/unable-to-enter-text-in-twitter-using-selenium-webdriver
Other Various Resources
- JavaDevJournal - Uploading File with Spring Boot - https://www.javadevjournal.com/spring/spring-file-upload/
- JUnit 5 Doc - https://junit.org/junit5/
- Oracle Java SE 8 Javadoc - https://docs.oracle.com/javase/8/docs/api/overview-summary.html
- MyBatis-Spring - http://mybatis.org/spring/
- Spring Framework Guru - Using @RequestMapping - https://springframework.guru/spring-requestmapping-annotation/
- Guru99
- XPath in Selenium Web Driver - https://www.guru99.com/xpath-selenium.html
- Implicit, Explicit & Fluent Waits in Selenium - https://www.guru99.com/implicit-explicit-waits-selenium.html
- The Art of the Web - Html5 Validation Examples - https://www.the-art-of-web.com/html/html5-form-validation/
- Useful Angle - Validate URL - https://usefulangle.com/post/36/javascript-validate-url-form-input-field-without-regex
- Arul Rai - WebSparrow.org - uploading multi-part files - https://www.websparrow.org/spring/spring-boot-rest-api-file-upload-save-example
- W.S. Toh - Code-boxx.com - Using AJAX to fetch data from the server - https://code-boxx.com/submit-form-without-refreshing-page/
- Javascript.info - Using the HTMLHttpRequest object - https://javascript.info/xmlhttprequest
- HowToDoInJava.com - Java Escape HTML - https://howtodoinjava.com/java/string/escape-html-encode-string/
- Nam Ha Minh - Java Servlet File Download - https://www.codejava.net/java-ee/servlet/java-servlet-download-file-example
- Rita Łyczywek - Writing a good README - https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project
- GitHub Doc - Markdown - https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
- TonyD at Google Groups - Explicit Waits with PageFoctory - https://groups.google.com/g/webdriver/c/7AGczMaV578?pli=1
- All Selenium - How to work with expected conditions - http://allselenium.info/work-with-expected-conditions-explicit-waits/
- Ipseeta Priyadarshini - Anonymous fucntions in Java
- Rajeev Singh - file upload example
- How to Program Blog - Junit and files.
- Himanshu Dahiya MyBatis Annotations and Result MappingUdacity Knowledge Base Answers:
- Eban D - Escaping quotes in Thymeleaf - https://knowledge.udacity.com/questions/275287
- Utkarsh S - Generating a Secure Key - https://knowledge.udacity.com/questions/275248
- Davide N - How to handle MaxUploadSizeExceededException - https://knowledge.udacity.com/questions/289021
- Daniel Brinzoi - https://github.com/danielbrinzoi - Fellow student. Reviewed his Junit tests while researching why the ExpectedConditions were always returning untrue conditions.
- Amit Sethi - Proper use of Java SecureRandom - https://www.synopsys.com/blogs/software-security/proper-use-of-javas-securerandom/
- Java T Point - Java String Format - https://www.javatpoint.com/java-string-format
- Tutorials Point - Java Cryptography - KeyGenerator - https://www.tutorialspoint.com/java_cryptography/java_cryptography_keygenerator.htm
- Wikipedia
- Data Encryption Standard - https://en.wikipedia.org/wiki/Data_Encryption_Standard
- Advanced Encryption Standard - https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
I found the most difficult aspect of this assignment to be working with the Selenium WebDriver, WebDriverWait and ExpectedConditions classes. In the course the PageFactory pattern was presented, but as I worked though my solution I found that the PageFactory didn't play well with WebDriverWait. There are many examples online of code that didn't work with the driver I was provided in the Maven project provided by the instructors.
I found that this code presented multiple places as a working example would not cause the driver to wait.
WebDriverWait wait = new WebDriverWait(driver, 3);
wait.until(webDriver -> webDriver.findElement(By.id("some-element")));
Passing WebElements created by the PageFactory worked but the WebDriver again would not wait, but immediately returned and not solving race error situations.
WebDriverWait wait = new WebDriverWait(driver, 10);
WebElement elemUsername = wait.until(ExpectedConditions.elementToBeClickable(pageFactoryElement));
elemUsername.sendKeys("xyz");
What worked for me was to include a new call to driver.findElement(By.x())
inside the ExpectedConditions function to provide the proper DOM context for
the wait object to call against. This is the code that finally worked for me:
WebDriverWait wait = new WebDriverWait(driver, 10);
WebElement el = wait.until(ExpectedConditions.visibilityOf(
driver.findElement(By.id("some-element-id")));
el.sendKeys("abc");
The ExpectedCondition.visibilityOf() was the most consistent method
for the tests in this project as others occasionally failed with
element not accessable errors.
Many thanks to my instructors and code reviewers at Udacity for the time and effort. Special thanks to Peter Zastoupil for developing the course.
This project pushes commits to a Jenkins installation in the AWS Cloud which deploys the application to a Docker container.