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

Move user journey tests to a package #562

Merged

Conversation

Ptroger
Copy link
Contributor

@Ptroger Ptroger commented Oct 11, 2024

User journey tests are run against the whole monorepo e2e.
They are meant to enforce core functionality works from the end user perspective.

This PR moves these tests from 'armory-sdk' to a different package 'user-journey'.

Copy link

vercel bot commented Oct 11, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
devtool ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 10:04am
manager 🔄 Building (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 10:04am

Copy link
Contributor

@mattschoch mattschoch left a comment

Choose a reason for hiding this comment

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

Seems okay to me!

Personally, I'd maybe just name the package e2e or e2e-test not user-journey, but not a super strong opinion.

@wcalderipe
Copy link
Collaborator

wcalderipe commented Oct 23, 2024

Seems okay to me!

Personally, I'd maybe just name the package e2e or e2e-test not user-journey, but not a super strong opinion.

Agree. Here's my 2 cents on the topic.

The convention adopted by NX is <projectName>-e2e. You can see this in Armory Cloud repository, where I intentionally left the test project behind.

image

However, in this case, we're not testing a single project but the entire stack. For instance, Twenty, a monorepo project I closely follow, uses a slightly different convention: https://github.com/twentyhq/twenty/tree/main/packages/twenty-e2e-testing.

I suggest we adopt something similar, like armory-e2e-testing. It clearly indicates that it's an E2E test for the entire project.

I'm aware that it currently clashes with the apps/armory project name and may be confusing in the short term. However, I believe we'll change that in the future to better represent the three components of the stack: Auth, Policy Engine, and Vault in the apps directory.

@Ptroger you can easily rename a project using NX's rename workspace https://nx.dev/nx-api/workspace/generators/move

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.

3 participants