[e2e] Update e2e lint rules to match best practices

[unlikelyzero]

Summary

• Nested describes makes it easy to write, but difficult to read a test. Furthermore, in the playwright world, nested describes can break parallelization and error reporting.
  https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/max-nested-describe.md
  Is a rule to enforce a limit of 1 for nested describes.
• We should also create a linter rule and helper function in the fixtures.js to allow us to log to console only when using the helper function.
  https://eslint.org/docs/4.0.0/rules/no-console
• We should disallow conditional logic within tests
  https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-conditional-in-test.md

[ozyx]

Testing Instructions

• Add a conditional to an e2e test such as an if/else, switch, or ternary statement.

• npm run lint, and see that the no-conditional-in-test warning is triggered for the added lines

• Add a nested test.describe of depth 2 to an e2e test such as:

test.describe('foo', () => {
    test.describe('bar', () => {
        // baz
    }
}

• npm run lint and notice that the max-nested-describe error is triggered for the added lines

[khalidadil]

@ozyx the playwright/no-conditional-in-test throws a warning, not an error. Is that right?

[ozyx]

@ozyx the playwright/no-conditional-in-test throws a warning, not an error. Is that right?

Correct, however, our 'npm run lint' fails if any warnings are detected. So we effectively treat all eslint warnings as errors.

[khalidadil]

got it! Then I'll mark this as verified.

Verified Fixed in Testathon on 08/04/22