Research and Provide a Demo of Unit Test Implementation for HfLA Repo

[abuna1985]

Overview

We need to see if it is feasible to implement unit tests for JavaScript functionality within the Hack for LA website repo, both within GitHub Action files and within client-side JavaScript. Ideally the same test framework would be used for unit testing both the back end and front end JavaScript.

Action Items

• Research implementation of unit tests in a Jekyll environment, with the goal of finding a test framework that could be used for automated testing of both the back end (GitHub Actions) and front end (client-side) JavaScript in the HfLA website repo. For the purpose of this issue, the test can be executed manually from the command-line, but it must be possible to incorporate into an automation in a future issue
  • Suggestions: Mocha, Jasmine
• Create a new branch and implement a library that provides unit testing
  • Add unit test for 1 JavaScript file within the HfLA website repo
  • Add unit test for 1 Github action file
• Create Draft Pull request with the unit test implementation for the dev team to review
• Demo the unit test implementation for the back-end meeting on Thursday
• Determine with the rest of the dev team whether adding unit tests is feasible after the demo

Resources/Instructions

https://mochajs.org/
https://jasmine.github.io/
Karma test runner

[nnr-nnr]

Availability: 3–8 PM M–F
ETA: 9 PM Thurs. 3/30/23

[nnr-nnr]

Progress Update

• There's seems to be limited info on testing in a Jekyll environment, so I think i'm going to stick with the linked resource.
• I got some questions answered at OHs about the logistics, ie that there is no backend team meeting and I could just present at a normal dev meeting. Also, that the "Draft Pull request" can just be treated as a PR that won't be merged.
• No blockers.
• Will work through the checklist this weekend.

[nnr-nnr]

Research implementation of unit tests in a Jekyll environment. Provide the results of the research in a comment within this issue.

There are limited information and resources on the web about unit testing in a Jekyll environment. Besides the library attached in this Issue (Joule, last updated 2017), I found suggestions of using GitHub actions to test code before pushing. Others suggest using the following together for a complete acceptance testing framework for Jekyll sites:

• RSpec — Behavior Driven Development for Ruby
• Capybara — Testing of web applications via simulation of a real user’s interaction with your app
• Selenium — Browser automation

[nnr-nnr]

BLOCKER:
I cannot do unit testing with Joule because I do not have permissions to install Joule in the repo. Running this command in terminal:
gem install jekyll-joule
resulted in this error message:

Fetching addressable-2.8.3.gem
Fetching sass-embedded-1.61.0-x86_64-darwin.gem
ERROR:  While executing gem ... (Gem::FilePermissionError)
    You don't have write permissions for the /Library/Ruby/Gems/2.6.0 directory.

[Dartis4]

Progress: Found a few leads for testing frameworks. Need to try implementing into the work flow to see ig things are viable. In talks with Roslyn and Will about viability of the libraries as well.
Blockers: None at the moment.
Availability: I should be available between 10am - 5pm each day this week.
ETA: Unknown

[Dartis4]

Progress: I believe this issue should be split into two separate issues and close this issue. The two new issues should be one focused on GitHub Actions unit testing, the other on frontend unit testing.
Blockers: None
Availability: 10am - 5pm
ETA: End of this week

[github-actions]

@Dartis4

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Wednesday, June 19, 2024 at 1:48 PM PST.}

[roslynwythe]

• @Dartis4 please see Research and Provide a Demo of Unit Testing for GHAs #7151 . Note the Draft label. Your comments would be appreciated. You are welcome to edit the issue directly or provide suggestions to me and I will edit. If you wish to be assigned to the issue, please create a comment, requesting the assignment from @ExperimentsInHonesty. Thank you for your excellent research and analysis.

[roslynwythe]

• @ExperimentsInHonesty I would like to close this issue and replace it with Research and Provide a Demo of Unit Testing for GHAs #7151 and Research and Provide a Demo of Unit Testing for front-end JavaScript code #7152