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

e2e: Move Code into src Folder for Better Organization #31504

Closed
nicobytes opened this issue Feb 27, 2025 · 1 comment · Fixed by #31505
Closed

e2e: Move Code into src Folder for Better Organization #31504

nicobytes opened this issue Feb 27, 2025 · 1 comment · Fixed by #31505

Comments

@nicobytes
Copy link
Contributor

Parent Issue

#31326

Task

Our e2e tests are increasing, and the current folder structure contains configuration files alongside the code folders. To improve maintainability and readability, we need to move all code-related folders into a src directory while keeping configuration files at the root.

.
├── data
├── eslint.config.mjs
├── index.js
├── locators
├── models
├── node_modules
├── package-lock.json
├── package.json
├── pages
├── playwright-report
├── playwright.config.ts
├── prettier-config.json
├── test-results
├── tests
├── tsconfig.json
├── utils
└── yarn.lock

Proposed Structure:

├── src
│   ├── data
│   ├── locators
│   ├── models
│   ├── pages
│   ├── tests
│   ├── utils
├── eslint.config.mjs
├── index.js
├── node_modules
├── package-lock.json
├── package.json
├── playwright-report
├── playwright.config.ts
├── prettier-config.json
├── test-results
├── tsconfig.json
└── yarn.lock

Proposed Objective

Please Select

Proposed Priority

Please Select

Acceptance Criteria

  • The folder structure is updated as proposed.
  • All imports are correctly updated to reflect the new paths.
  • All e2e tests pass successfully.
  • The project remains easy to navigate and maintain.

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

Copy link

@nicobytes nicobytes changed the title Move Code into src Folder for Better Organization e2e: Move Code into src Folder for Better Organization Feb 27, 2025
@nicobytes nicobytes moved this from In Progress to In Review in dotCMS - Product Planning Feb 27, 2025
github-merge-queue bot pushed a commit that referenced this issue Feb 27, 2025
)

### Parent Issue

#31504 

### Proposed Changes

This pull request includes several changes to improve the organization
and import paths of the end-to-end (E2E) test files in the
`dotcms-e2e-node` frontend project. The most important changes involve
renaming directories and updating import paths to use aliases for better
maintainability and readability.

Directory and file structure changes:

* Renamed the `e2e/dotcms-e2e-node/frontend/pages` directory to
`e2e/dotcms-e2e-node/frontend/src/pages` and updated the paths
accordingly.
(`[e2e/dotcms-e2e-node/frontend/src/pages/listingContentTypes.pages.tsL2-R2](diffhunk://#diff-014d304e7a539457bd4c8fff2c9192b089340dcd1a69370e64118e8073c8d2c2L2-R2)`)
* Renamed the `e2e/dotcms-e2e-node/frontend/tests` directory to
`e2e/dotcms-e2e-node/frontend/src/tests` and updated the paths
accordingly.
(`[[1]](diffhunk://#diff-29922bdcd9462a057fcd1b7a617e2a8b6a26e88c6d392a495895ac10f3dd2438L5-R10)`,
`[[2]](diffhunk://#diff-a3f281f417d2e319f033b783619addd3e6ce17396cf87d66b32a27a45494ac9cL5-R16)`,
`[[3]](diffhunk://#diff-a6a51a1183a9184ea790646a476dd07a3118fc332dd118d91e73987a065c875cL3-R3)`)

Import path updates:

* Updated import paths in
`e2e/dotcms-e2e-node/frontend/src/pages/listingContentTypes.pages.ts` to
use aliases (`@utils/api`).
(`[e2e/dotcms-e2e-node/frontend/src/pages/listingContentTypes.pages.tsL2-R2](diffhunk://#diff-014d304e7a539457bd4c8fff2c9192b089340dcd1a69370e64118e8073c8d2c2L2-R2)`)
* Updated import paths in
`e2e/dotcms-e2e-node/frontend/src/tests/contentSearch/contentEditing.spec.ts`
to use aliases (`@utils/dotCMSUtils`,
`@locators/navigation/menuLocators`).
(`[e2e/dotcms-e2e-node/frontend/src/tests/contentSearch/contentEditing.spec.tsL5-R10](diffhunk://#diff-29922bdcd9462a057fcd1b7a617e2a8b6a26e88c6d392a495895ac10f3dd2438L5-R10)`)
* Updated import paths in
`e2e/dotcms-e2e-node/frontend/src/tests/contentSearch/portletIntegrity.spec.ts`
to use aliases (`@utils/dotCMSUtils`, `@locators/globalLocators`,
`@locators/navigation/menuLocators`).
(`[e2e/dotcms-e2e-node/frontend/src/tests/contentSearch/portletIntegrity.spec.tsL5-R16](diffhunk://#diff-a3f281f417d2e319f033b783619addd3e6ce17396cf87d66b32a27a45494ac9cL5-R16)`)
* Updated import paths in
`e2e/dotcms-e2e-node/frontend/src/tests/login/translations.spec.ts` to
use aliases (`@utils/dotCMSUtils`).
(`[e2e/dotcms-e2e-node/frontend/src/tests/login/translations.spec.tsL3-R3](diffhunk://#diff-a6a51a1183a9184ea790646a476dd07a3118fc332dd118d91e73987a065c875cL3-R3)`)
* Updated import paths in
`e2e/dotcms-e2e-node/frontend/src/utils/contentUtils.ts` to use aliases
(`@locators/globalLocators`).
(`[e2e/dotcms-e2e-node/frontend/src/utils/contentUtils.tsL7-R7](diffhunk://#diff-9db0bb632d4d5a4d318659569358e671b816bcd7549f3fc46df4477bb5d2544bL7-R7)`)

Test directory configuration:

* Changed the `testDir` configuration in
`e2e/dotcms-e2e-node/frontend/playwright.config.ts` to point to the new
`src/tests` directory.
(`[e2e/dotcms-e2e-node/frontend/playwright.config.tsL41-R41](diffhunk://#diff-2db21369684b5f6dd698eb7a6eb71c0d0a92d245e61e26ed3a3c33bed5f6d0faL41-R41)`)

### Checklist
- [x] Tests
- [x] Translations
- [x] Security Implications Contemplated (add notes if applicable)
@github-project-automation github-project-automation bot moved this from In Review to Done in dotCMS - Product Planning Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant