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

Update-Acceptance-highload-edit-form-menu-test Acceptance #1617

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

BobrikovMikhail
Copy link
Contributor

@BobrikovMikhail BobrikovMikhail commented Aug 9, 2024

Summary by CodeRabbit

  • Tests
    • Enhanced the structure and logic of the high-load edit form menu tests for improved readability and maintainability.
    • Updated tests to handle asynchronous operations more effectively, ensuring accurate state reflection before assertions.

Copy link

sonarcloud bot commented Aug 9, 2024

Copy link

coderabbitai bot commented Oct 23, 2024

Walkthrough

The changes in the pull request focus on enhancing the structure and logic of the highload-edit-form-menu-test.js file within the Ember testing framework. Key modifications include the adoption of setupApplicationTest, refactoring of lifecycle hooks to improve readability, and converting the test function to an asynchronous format. The use of settled replaces wait, streamlining the handling of asynchronous actions. These updates aim to align the test with modern Ember practices, improving its maintainability and clarity.

Changes

File Path Change Summary
tests/acceptance/components/highload-edit-form-menu-test.js Updated to use setupApplicationTest, refactored beforeEach and afterEach hooks, changed test function to async, replaced wait with settled, and streamlined assertions.

Poem

In the land of Ember, tests take flight,
With hooks and awaits, they shine so bright.
No more tangled waits, just settled grace,
Each assertion now finds its rightful place.
Hopping through code with joy and glee,
Our tests are now as smooth as can be! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (3)
tests/acceptance/components/highload-edit-form-menu-test.js (3)

1-8: Consider organizing imports for better readability.

Consider grouping imports into three distinct sections:

  1. Third-party packages (jquery, qunit)
  2. Ember core imports (@ember/*)
  3. Local imports (helpers)
 import $ from 'jquery';
 import { module, test } from 'qunit';
-import startApp from '../../helpers/start-app';
-import { settled } from '@ember/test-helpers';
-import { visit, currentURL } from '@ember/test-helpers';
-import { setupApplicationTest } from 'ember-qunit';
-import { run } from '@ember/runloop';
+import { run } from '@ember/runloop';
+import { settled, visit, currentURL } from '@ember/test-helpers';
+import { setupApplicationTest } from 'ember-qunit';
+import startApp from '../../helpers/start-app';

25-27: Consider extracting path to a constant.

The hardcoded path could be moved to a constant at the top of the file for better maintainability.

+const TEST_ROUTE = 'components-examples/highload-edit-form-menu/index';
+
 test('it properly renders', async function (assert) {
   assert.expect(7);
-  let path = 'components-examples/highload-edit-form-menu/index';
-  await visit(path);
-  assert.equal(currentURL(), path);
+  await visit(TEST_ROUTE);
+  assert.equal(currentURL(), TEST_ROUTE);

22-54: Consider restructuring test for better maintainability.

The test could benefit from several architectural improvements:

  1. Extract common selectors into a constants object
  2. Group related assertions into separate test cases
  3. Consider creating page object for encapsulating UI interactions
  4. Add comments explaining the business logic being tested

This would make the test more maintainable and easier to understand.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fdcaa3d and ba3061f.

📒 Files selected for processing (1)
  • tests/acceptance/components/highload-edit-form-menu-test.js (1 hunks)
🧰 Additional context used

Comment on lines +35 to +38
run(() => {
$('.tabsNavigation')[0].click();
});

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Replace run() and jQuery clicks with modern click helper.

The test uses run() and jQuery for click events. Consider using the modern @ember/test-helpers click helper.

-    run(() => {
-      $('.tabsNavigation')[0].click();
-    });
+    await click('[data-test-tab-navigation="0"]');

-    run(() => {
-      $('.tabsNavigation')[1].click();
-    });
+    await click('[data-test-tab-navigation="1"]');

-    run(() => {
-      $('.showAllFormsButton').click();
-    });
+    await click('[data-test-show-all-forms]');

Also applies to: 42-44, 49-51

Comment on lines +10 to +20
module('Acceptance | high-edit-form-menu', function (hooks) {
setupApplicationTest(hooks);

module('Acceptance | high-edit-form-menu', {
beforeEach() {
hooks.beforeEach(function () {
app = startApp();
},
});

afterEach() {
hooks.afterEach(function () {
// Destroy application.
run(app, 'destroy');
},
});
});
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider modernizing hooks implementation.

The hooks implementation could be improved for consistency with the async pattern used in the test.

 module('Acceptance | high-edit-form-menu', function (hooks) {
   setupApplicationTest(hooks);

-  hooks.beforeEach(function () {
+  hooks.beforeEach(async function () {
     app = startApp();
   });

-  hooks.afterEach(function () {
+  hooks.afterEach(async function () {
     // Destroy application.
-    run(app, 'destroy');
+    await run(app, 'destroy');
   });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
module('Acceptance | high-edit-form-menu', function (hooks) {
setupApplicationTest(hooks);
module('Acceptance | high-edit-form-menu', {
beforeEach() {
hooks.beforeEach(function () {
app = startApp();
},
});
afterEach() {
hooks.afterEach(function () {
// Destroy application.
run(app, 'destroy');
},
});
});
module('Acceptance | high-edit-form-menu', function (hooks) {
setupApplicationTest(hooks);
hooks.beforeEach(async function () {
app = startApp();
});
hooks.afterEach(async function () {
// Destroy application.
await run(app, 'destroy');
});

Comment on lines +22 to 24
test('it properly renders', async function (assert) {
assert.expect(7);

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider using data-test- selectors.*

Using class selectors for testing is brittle as they may change for styling purposes. Consider adding dedicated test selectors.

-    $('.object-list-view').find('tr')[1].children[1].click();
+    await click('[data-test-object-list-row="1"] [data-test-cell="1"]');

Committable suggestion was skipped due to low confidence.

Comment on lines +30 to +34
await settled();
assert.equal($('.gruppaPolejVvoda').length, 4, 'all tabs are here');
assert.equal($('.gruppaPolejVvoda.active').length, 1, 'only one tab is active');
assert.equal($('.gruppaPolejVvoda')[0].classList.contains('active'), true, 'first tab is active');

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Replace jQuery assertions with modern test helpers.

The test relies heavily on jQuery for assertions. Consider using modern test helpers and data-test-* selectors.

-    assert.equal($('.gruppaPolejVvoda').length, 4, 'all tabs are here');
-    assert.equal($('.gruppaPolejVvoda.active').length, 1, 'only one tab is active');
-    assert.equal($('.gruppaPolejVvoda')[0].classList.contains('active'), true, 'first tab is active');
+    assert.dom('[data-test-tab]').exists({ count: 4 }, 'all tabs are here');
+    assert.dom('[data-test-tab].active').exists({ count: 1 }, 'only one tab is active');
+    assert.dom('[data-test-tab="0"]').hasClass('active', 'first tab is active');

Committable suggestion was skipped due to low confidence.

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

Successfully merging this pull request may close these issues.

2 participants