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

Adding local Cypress files and demo functional test #2

Merged
merged 1 commit into from
Jul 12, 2021
Merged

Conversation

AvivBenchorin
Copy link
Owner

@AvivBenchorin AvivBenchorin commented Jul 8, 2021

Description

With the existing repository, there is not yet functionality to run Cypress or other test writing software. This PR aim to further sets up the repository for proper development by adding TypeScript and ESLint as dependencies, and creating the Cypress folder structure. It also adds a demo Cypress functional test to be run on OpenSearch Dashboards, as well as updates the .gitignore and the index.js file under the support Cypress directory.

Signed-off-by: Aviv Benchorin [email protected]

Issues Resolved

N/A

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

Copy link
Collaborator

@tianleh tianleh left a comment

Choose a reason for hiding this comment

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

  1. Make sure the commits are squashed into one commit when merging.

  2. Add Eslint for easy formatting. https://eslint.org/docs/user-guide/getting-started (OK to do it in a follow up PR)

@riysaxen-amzn
Copy link
Collaborator

Follow Javascript standards to document the code refer https://gomakethings.com/whats-the-best-way-to-document-javascript/ for best practices.

@kavilla
Copy link

kavilla commented Jul 9, 2021

Looks cool so far, would be possible to add a quick note in the README on how to run the tests. Save some time for others. For me I ran through https://docs.cypress.io/guides/getting-started/installing-cypress#System-requirements and I seem to be able to get the test running but it hangs.

@kavilla
Copy link

kavilla commented Jul 9, 2021

1. Make sure the commits are squashed into one commit when merging.

2. Add Eslint for easy formatting. https://eslint.org/docs/user-guide/getting-started (OK to do it in a follow up PR)

+1 to both,

  1. Technically all commits are reviewable, and I see some merge commits. I recommend rebasing for those so an extra commit doesn't show up. Makes the commit history more clean and cool. 😎

@ananzh
Copy link
Collaborator

ananzh commented Jul 9, 2021

Aviv, maybe you can create an issue to document any thoughts, designs, discussions and any progresses. Later, you can decide to close it or leave it for other people to contribute. An example here for reference.

Meanwhile for this PR, probably better to give a bit more intro in the Description. I would suggest to formalize your PR and give more details. Here are two examples:
#392
#540

I think you can write the discussion or thoughts in either issue/PR. If you have multiple PRs then I would suggest write more details in issue.

@AvivBenchorin
Copy link
Owner Author

Looks cool so far, would be possible to add a quick note in the README on how to run the tests. Save some time for others. For me I ran through https://docs.cypress.io/guides/getting-started/installing-cypress#System-requirements and I seem to be able to get the test running but it hangs.

Added more details to README.

@@ -21,6 +21,15 @@
},
"homepage": "https://github.com/AvivBenchorin/monterey#readme",
"devDependencies": {
"cypress": "^7.6.0"
"@typescript-eslint/eslint-plugin": "^4.28.2",
Copy link
Collaborator

Choose a reason for hiding this comment

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

add how to run eslint into readme. Not necessary in this PR, you might address this in future PR.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Will address in next PR.

Setting up the Cypress folder structure and other repository dependencies such as TypeScript and ESLint. This adds a working Cypress functional test to run on OpenSearch Dashboards, and updates the .gitignore to include local Cypress files. As well, this adds instructions to the README on how to setup and run the Cypress tests.

Signed-off-by: Aviv Benchorin <[email protected]>
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.

7 participants