Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow CA Sabina Kutniauske #260

Open
wants to merge 47 commits into
base: master
Choose a base branch
from
Open

Conversation

saibia8
Copy link

@saibia8 saibia8 commented Aug 20, 2023

Summary by CodeRabbit


  • New Feature: Added badges for automated unit testing and E2E testing, providing real-time status updates on code quality and functionality.
  • Chore: Installed eslint and prettier to enforce consistent coding styles and improve code readability.
  • Chore: Implemented a pre-commit eslint hook to ensure code quality before commits.
  • Test: Introduced Jest for unit testing, enhancing the reliability of our application.
  • Test: Incorporated Cypress for E2E testing, ensuring seamless user experiences from start to finish.
  • Test: Created test files for login and logout functionality, verifying the security and effectiveness of these critical features.

@github-actions
Copy link

github-actions bot commented Aug 20, 2023

Image description CodeRabbit

Walkthrough

This update introduces a robust testing and code quality framework to the project. It includes automated unit and E2E testing, linting, and code formatting. The changes also cover the creation of test files for login and logout functionality.

Changes

File Summary
README.md Added badges for automated unit testing and E2E testing. Installed eslint, prettier, pre-commit eslint hook, jest for unit testing, and cypress for E2E testing. Created test files for login and logout functionality.

🐇

In the land where code rabbits dwell,

We've spun a testing and linting spell.

Jest and Cypress, side by side,

With Prettier and ESLint as our guide.

Login, logout, tested with care,

Ensuring no bugs hide in there.

So here's to code that's clean and neat,

Making our project truly elite! 🎉


Uplevel your code reviews with CodeRabbit Pro

CodeRabbit Pro

If you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description CodeRabbit

Commits Files that changed from the base of the PR and between 5cdcf16 and c12805d commits.
Files selected (96)
  • .eslintrc.json (1)
  • .github/workflows/e2e-test.yml (1)
  • .github/workflows/static.yml (1)
  • .github/workflows/unit-test.yml (1)
  • .gitignore (1)
  • .husky/_/husky.sh (1)
  • .husky/pre-commit (1)
  • 6 (1)
  • README.md (1)
  • cypress.config.js (1)
  • cypress/e2e/User-login-and-access-profile/login.cy.js (1)
  • cypress/support/commands.js (1)
  • cypress/support/e2e.js (1)
  • src/js/api/apiBase.js (1)
  • src/js/api/auth/index.js (1)
  • src/js/api/auth/login.js (1)
  • src/js/api/auth/login.test.js (1)
  • src/js/api/auth/logout.js (1)
  • src/js/api/auth/logout.test.js (1)
  • src/js/api/auth/register.js (1)
  • src/js/api/auth/state.js (1)
  • src/js/api/constants.js (1)
  • src/js/api/headers.js (2)
  • src/js/api/index.js (1)
  • src/js/api/mock/localStorage.mock.js (1)
  • src/js/api/posts/comment.js (1)
  • src/js/api/posts/create.js (1)
  • src/js/api/posts/delete.js (1)
  • src/js/api/posts/index.js (1)
  • src/js/api/posts/react.js (1)
  • src/js/api/posts/read.js (1)
  • src/js/api/posts/update.js (1)
  • src/js/api/profiles/delete.js (1)
  • src/js/api/profiles/follow.js (1)
  • src/js/api/profiles/index.js (1)
  • src/js/api/profiles/read.js (1)
  • src/js/api/profiles/unfollow.js (1)
  • src/js/api/profiles/update.js (1)
  • src/js/data/blank/post.js (1)
  • src/js/index.js (1)
  • src/js/listeners/auth/index.js (1)
  • src/js/listeners/auth/login.js (1)
  • src/js/listeners/auth/logout.js (1)
  • src/js/listeners/auth/register.js (1)
  • src/js/listeners/index.js (1)
  • src/js/listeners/post/comment.js (1)
  • src/js/listeners/post/index.js (1)
  • src/js/listeners/post/reaction.js (1)
  • src/js/listeners/profile/follow.js (1)
  • src/js/listeners/profile/index.js (1)
  • src/js/listeners/profile/unfollow.js (1)
  • src/js/router/index.js (1)
  • src/js/router/searchParams.js (1)
  • src/js/storage/index.js (1)
  • src/js/storage/load.js (1)
  • src/js/storage/save.js (1)
  • src/js/templates/comment/badge.js (1)
  • src/js/templates/comment/comment.js (3)
  • src/js/templates/comment/form.js (1)
  • src/js/templates/comment/index.js (1)
  • src/js/templates/index.js (1)
  • src/js/templates/instance.js (1)
  • src/js/templates/post/actions.js (1)
  • src/js/templates/post/comments.js (1)
  • src/js/templates/post/footer.js (1)
  • src/js/templates/post/form.js (3)
  • src/js/templates/post/header.js (1)
  • src/js/templates/post/index.js (1)
  • src/js/templates/post/loader.js (1)
  • src/js/templates/post/media.js (2)
  • src/js/templates/post/page.js (1)
  • src/js/templates/post/reactions.js (1)
  • src/js/templates/post/tabs.js (1)
  • src/js/templates/post/tags.js (1)
  • src/js/templates/post/thumbnail.js (1)
  • src/js/templates/profile/button.js (1)
  • src/js/templates/profile/followers.js (1)
  • src/js/templates/profile/following.js (1)
  • src/js/templates/profile/follows.js (1)
  • src/js/templates/profile/index.js (1)
  • src/js/templates/profile/page.js (1)
  • src/js/templates/profile/thumbnail.js (1)
  • src/js/tools/clear.js (1)
  • src/js/tools/emojiSubset.js (1)
  • src/js/tools/index.js (1)
  • src/js/ui/auth.js (1)
  • src/js/ui/footer.js (1)
  • src/js/ui/header.js (1)
  • src/js/ui/index.js (1)
  • src/js/ui/modals.js (1)
  • src/js/ui/renderView.js (1)
  • src/js/views/index.js (1)
  • src/js/views/postList.js (1)
  • src/js/views/postPage.js (2)
  • src/js/views/profileList.js (1)
  • src/js/views/profilePage.js (1)
Files ignored due to filter (4)
  • babel.config.json
  • cypress/fixtures/example.json
  • package-lock.json
  • package.json
Files not summarized due to errors (96)
  • .github/workflows/unit-test.yml (nothing obtained from openai)
  • .eslintrc.json (nothing obtained from openai)
  • .github/workflows/static.yml (nothing obtained from openai)
  • .gitignore (nothing obtained from openai)
  • .github/workflows/e2e-test.yml (nothing obtained from openai)
  • .husky/_/husky.sh (nothing obtained from openai)
  • 6 (nothing obtained from openai)
  • cypress.config.js (nothing obtained from openai)
  • README.md (nothing obtained from openai)
  • .husky/pre-commit (nothing obtained from openai)
  • cypress/support/commands.js (nothing obtained from openai)
  • cypress/e2e/User-login-and-access-profile/login.cy.js (nothing obtained from openai)
  • cypress/support/e2e.js (nothing obtained from openai)
  • src/js/api/apiBase.js (nothing obtained from openai)
  • src/js/api/auth/index.js (nothing obtained from openai)
  • src/js/api/auth/login.test.js (nothing obtained from openai)
  • src/js/api/auth/logout.js (nothing obtained from openai)
  • src/js/api/auth/login.js (nothing obtained from openai)
  • src/js/api/auth/register.js (nothing obtained from openai)
  • src/js/api/auth/logout.test.js (nothing obtained from openai)
  • src/js/api/auth/state.js (nothing obtained from openai)
  • src/js/api/constants.js (nothing obtained from openai)
  • src/js/api/index.js (nothing obtained from openai)
  • src/js/api/headers.js (nothing obtained from openai)
  • src/js/api/posts/comment.js (nothing obtained from openai)
  • src/js/api/mock/localStorage.mock.js (nothing obtained from openai)
  • src/js/api/posts/create.js (nothing obtained from openai)
  • src/js/api/posts/delete.js (nothing obtained from openai)
  • src/js/api/posts/index.js (nothing obtained from openai)
  • src/js/api/posts/react.js (nothing obtained from openai)
  • src/js/api/posts/read.js (nothing obtained from openai)
  • src/js/api/posts/update.js (nothing obtained from openai)
  • src/js/api/profiles/follow.js (nothing obtained from openai)
  • src/js/api/profiles/delete.js (nothing obtained from openai)
  • src/js/api/profiles/index.js (nothing obtained from openai)
  • src/js/api/profiles/read.js (nothing obtained from openai)
  • src/js/api/profiles/unfollow.js (nothing obtained from openai)
  • src/js/api/profiles/update.js (nothing obtained from openai)
  • src/js/data/blank/post.js (nothing obtained from openai)
  • src/js/index.js (nothing obtained from openai)
  • src/js/listeners/auth/index.js (nothing obtained from openai)
  • src/js/listeners/auth/login.js (nothing obtained from openai)
  • src/js/listeners/auth/register.js (nothing obtained from openai)
  • src/js/listeners/auth/logout.js (nothing obtained from openai)
  • src/js/listeners/index.js (nothing obtained from openai)
  • src/js/listeners/post/comment.js (nothing obtained from openai)
  • src/js/listeners/post/index.js (nothing obtained from openai)
  • src/js/listeners/post/reaction.js (nothing obtained from openai)
  • src/js/listeners/profile/follow.js (nothing obtained from openai)
  • src/js/listeners/profile/index.js (nothing obtained from openai)
  • src/js/listeners/profile/unfollow.js (nothing obtained from openai)
  • src/js/router/index.js (nothing obtained from openai)
  • src/js/router/searchParams.js (nothing obtained from openai)
  • src/js/storage/index.js (nothing obtained from openai)
  • src/js/storage/save.js (nothing obtained from openai)
  • src/js/storage/load.js (nothing obtained from openai)
  • src/js/templates/comment/comment.js (nothing obtained from openai)
  • src/js/templates/comment/badge.js (nothing obtained from openai)
  • src/js/templates/comment/form.js (nothing obtained from openai)
  • src/js/templates/comment/index.js (nothing obtained from openai)
  • src/js/templates/index.js (nothing obtained from openai)
  • src/js/templates/instance.js (nothing obtained from openai)
  • src/js/templates/post/actions.js (nothing obtained from openai)
  • src/js/templates/post/comments.js (nothing obtained from openai)
  • src/js/templates/post/footer.js (nothing obtained from openai)
  • src/js/templates/post/form.js (nothing obtained from openai)
  • src/js/templates/post/header.js (nothing obtained from openai)
  • src/js/templates/post/index.js (nothing obtained from openai)
  • src/js/templates/post/loader.js (nothing obtained from openai)
  • src/js/templates/post/media.js (nothing obtained from openai)
  • src/js/templates/post/page.js (nothing obtained from openai)
  • src/js/templates/post/reactions.js (nothing obtained from openai)
  • src/js/templates/post/tabs.js (nothing obtained from openai)
  • src/js/templates/post/thumbnail.js (nothing obtained from openai)
  • src/js/templates/post/tags.js (nothing obtained from openai)
  • src/js/templates/profile/button.js (nothing obtained from openai)
  • src/js/templates/profile/followers.js (nothing obtained from openai)
  • src/js/templates/profile/following.js (nothing obtained from openai)
  • src/js/templates/profile/follows.js (nothing obtained from openai)
  • src/js/templates/profile/index.js (nothing obtained from openai)
  • src/js/templates/profile/page.js (nothing obtained from openai)
  • src/js/templates/profile/thumbnail.js (nothing obtained from openai)
  • src/js/tools/clear.js (nothing obtained from openai)
  • src/js/tools/emojiSubset.js (nothing obtained from openai)
  • src/js/tools/index.js (nothing obtained from openai)
  • src/js/ui/auth.js (nothing obtained from openai)
  • src/js/ui/header.js (nothing obtained from openai)
  • src/js/ui/footer.js (nothing obtained from openai)
  • src/js/ui/index.js (nothing obtained from openai)
  • src/js/ui/modals.js (nothing obtained from openai)
  • src/js/ui/renderView.js (nothing obtained from openai)
  • src/js/views/index.js (nothing obtained from openai)
  • src/js/views/postList.js (nothing obtained from openai)
  • src/js/views/postPage.js (nothing obtained from openai)
  • src/js/views/profileList.js (nothing obtained from openai)
  • src/js/views/profilePage.js (nothing obtained from openai)
Files not reviewed due to errors (96)
  • .eslintrc.json (no response)
  • .github/workflows/unit-test.yml (no response)
  • .github/workflows/e2e-test.yml (no response)
  • .husky/_/husky.sh (no response)
  • .gitignore (no response)
  • .github/workflows/static.yml (no response)
  • README.md (no response)
  • cypress.config.js (no response)
  • cypress/e2e/User-login-and-access-profile/login.cy.js (no response)
  • cypress/support/commands.js (no response)
  • 6 (no response)
  • .husky/pre-commit (no response)
  • src/js/api/apiBase.js (no response)
  • src/js/api/auth/logout.js (no response)
  • src/js/api/auth/login.test.js (no response)
  • cypress/support/e2e.js (no response)
  • src/js/api/auth/index.js (no response)
  • src/js/api/auth/login.js (no response)
  • src/js/api/auth/logout.test.js (no response)
  • src/js/api/index.js (no response)
  • src/js/api/headers.js (no response)
  • src/js/api/constants.js (no response)
  • src/js/api/auth/register.js (no response)
  • src/js/api/auth/state.js (no response)
  • src/js/api/posts/react.js (no response)
  • src/js/api/posts/create.js (no response)
  • src/js/api/mock/localStorage.mock.js (no response)
  • src/js/api/posts/index.js (no response)
  • src/js/api/posts/comment.js (no response)
  • src/js/api/posts/delete.js (no response)
  • src/js/api/posts/update.js (no response)
  • src/js/api/profiles/delete.js (no response)
  • src/js/api/profiles/follow.js (no response)
  • src/js/api/profiles/index.js (no response)
  • src/js/api/posts/read.js (no response)
  • src/js/api/profiles/read.js (no response)
  • src/js/index.js (no response)
  • src/js/listeners/auth/index.js (no response)
  • src/js/listeners/auth/login.js (no response)
  • src/js/data/blank/post.js (no response)
  • src/js/api/profiles/update.js (no response)
  • src/js/api/profiles/unfollow.js (no response)
  • src/js/listeners/post/reaction.js (no response)
  • src/js/listeners/auth/logout.js (no response)
  • src/js/listeners/index.js (no response)
  • src/js/listeners/post/index.js (no response)
  • src/js/listeners/post/comment.js (no response)
  • src/js/listeners/auth/register.js (no response)
  • src/js/listeners/profile/unfollow.js (no response)
  • src/js/listeners/profile/follow.js (no response)
  • src/js/storage/index.js (no response)
  • src/js/router/index.js (no response)
  • src/js/listeners/profile/index.js (no response)
  • src/js/router/searchParams.js (no response)
  • src/js/storage/load.js (no response)
  • src/js/storage/save.js (no response)
  • src/js/templates/comment/form.js (no response)
  • src/js/templates/comment/comment.js (no response)
  • src/js/templates/comment/badge.js (no response)
  • src/js/templates/comment/index.js (no response)
  • src/js/templates/post/comments.js (no response)
  • src/js/templates/index.js (no response)
  • src/js/templates/post/footer.js (no response)
  • src/js/templates/post/actions.js (no response)
  • src/js/templates/instance.js (no response)
  • src/js/templates/post/form.js (no response)
  • src/js/templates/post/loader.js (no response)
  • src/js/templates/post/page.js (no response)
  • src/js/templates/post/media.js (no response)
  • src/js/templates/post/index.js (no response)
  • src/js/templates/post/header.js (no response)
  • src/js/templates/post/reactions.js (no response)
  • src/js/templates/post/tabs.js (no response)
  • src/js/templates/post/thumbnail.js (no response)
  • src/js/templates/profile/button.js (no response)
  • src/js/templates/profile/followers.js (no response)
  • src/js/templates/profile/following.js (no response)
  • src/js/templates/post/tags.js (no response)
  • src/js/templates/profile/index.js (no response)
  • src/js/templates/profile/follows.js (no response)
  • src/js/templates/profile/thumbnail.js (no response)
  • src/js/templates/profile/page.js (no response)
  • src/js/tools/clear.js (no response)
  • src/js/tools/emojiSubset.js (no response)
  • src/js/ui/auth.js (no response)
  • src/js/ui/header.js (no response)
  • src/js/ui/modals.js (no response)
  • src/js/tools/index.js (no response)
  • src/js/ui/footer.js (no response)
  • src/js/ui/index.js (no response)
  • src/js/views/postPage.js (no response)
  • src/js/views/index.js (no response)
  • src/js/views/profilePage.js (no response)
  • src/js/ui/renderView.js (no response)
  • src/js/views/profileList.js (no response)
  • src/js/views/postList.js (no response)
Review comments generated (0)
  • Review: 0
  • LGTM: 0

Tips

Chat with Image description CodeRabbit Bot (@coderabbitai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

  • Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

Copy link
Collaborator

@Fermain Fermain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert the 90ish formatting changes to make this PR easier to read.

This reverts commit 93ba176.

			#	modified:   src/js/views/profilePage.js
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description CodeRabbit

Commits Files that changed from the base of the PR and between c12805d and f886ceb commits.
Files selected (1)
  • README.md (1)
Review comments generated (1)
  • Review: 1
  • LGTM: 0

Tips

Chat with Image description CodeRabbit Bot (@coderabbitai)

  • Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
  • Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

  • The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
  • You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

  • Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

Comment on lines +1 to +13
#Workflow CA

[![Automated Unit Testing](https://github.com/saibia8/social-media-client-Sabina/actions/workflows/unit-test.yml/badge.svg?branch=Testing-PR)](https://github.com/saibia8/social-media-client-Sabina/actions/workflows/unit-test.yml)

[![Automated E2E Testing](https://github.com/saibia8/social-media-client-Sabina/actions/workflows/e2e-test.yml/badge.svg?branch=Testing-PR)](https://github.com/saibia8/social-media-client-Sabina/actions/workflows/e2e-test.yml)

Installed eslint and patched version v.1.0.1
Installed prettier, formated javascript files and patched version v1.0.2
Installed pre-commit eslint hook and patched version v1.0.3
Installed jest for unit-testing and patched version v1.0.4
Installed cypress for e2e-testing and patched version v1.0.5
Created test files login.test.js and logout.test.js and patched version v1.0.6
Created test file login.cy.js and action to static pages, patched version v1.0.7

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image description CodeRabbit

The changes made to the README.md file are generally good, providing clear information about the testing and linting tools added to the project. However, the term "patched version" is used repeatedly but it's not clear what it refers to. It would be more informative if each line that introduces a new tool or test also briefly describes its purpose or how it improves the project.

Installed eslint (for identifying and reporting on patterns in ECMAScript/JavaScript code) and updated to version v.1.0.1
Installed prettier (an opinionated code formatter), formatted javascript files and updated to version v1.0.2
Installed pre-commit eslint hook (to ensure all committed code adheres to defined coding standards) and updated to version v1.0.3
Installed jest for unit-testing (to verify the correctness of individual units of source code) and updated to version v1.0.4
Installed cypress for e2e-testing (to test whether the flow of an application is performing as designed from start to finish) and updated to version v1.0.5
Created test files login.test.js and logout.test.js (to verify login and logout functionality) and updated to version v1.0.6
Created test file login.cy.js and action to static pages, updated to version v1.0.7

@saibia8
Copy link
Author

saibia8 commented Aug 31, 2023

Hello,
I have reverted the commit with prettier formatting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants