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

test(scapegoat): acceptance tests #884

Merged
merged 4 commits into from
Sep 17, 2024

Conversation

antoinezanardi
Copy link
Owner

@antoinezanardi antoinezanardi commented Sep 17, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new project run configuration for Cucumber.js testing, enhancing acceptance test execution.
    • Added narrative elements to the Scapegoat role, enriching player engagement and game dynamics.
    • Implemented functionality for the Scapegoat to ban players from voting, affecting game strategy.
  • Bug Fixes

    • Removed outdated step definitions to streamline game-play testing.
  • Documentation

    • Updated localization strings for consistency and improved storytelling in both English and French.
  • Tests

    • Expanded acceptance tests to cover new functionalities related to the Scapegoat role.

@antoinezanardi antoinezanardi added the ✅ test Adding missing tests or correcting existing tests label Sep 17, 2024
@antoinezanardi antoinezanardi self-assigned this Sep 17, 2024
Copy link

coderabbitai bot commented Sep 17, 2024

Walkthrough

This pull request introduces a new configuration file for a Cucumber.js testing setup named "Scapegoat Role," facilitating acceptance tests execution. It modifies localization files to enhance narrative descriptions related to the Scapegoat role in both English and French. Additionally, it adds and modifies step definitions in acceptance tests to accommodate new gameplay mechanics, such as banning players from voting, while also removing outdated step definitions and adjusting test setup configurations.

Changes

File Path Change Summary
.run/Scapegoat Role.run.xml Added a new project run configuration for Cucumber.js testing for the "Scapegoat Role."
modules/i18n/locales/en.json Modified strings to capitalize "Scapegoat" and enhance narrative descriptions.
modules/i18n/locales/fr.json Modified a string to include a dramatic phrase in the description of the "Bouc Émissaire" role.
tests/acceptance/features/game/features/role/scapegoat.feature Added a feature scenario outlining the Scapegoat's mechanics in the game.
tests/acceptance/features/game/step-definitions/game-play/game-play.then-steps.ts Removed a step definition related to player targeting in the game.
tests/acceptance/features/game/step-definitions/game-play/game-play.when-steps.ts Added a step definition for the Scapegoat to ban players from voting.
tests/acceptance/features/game/step-definitions/player/player-attribute/player-attribute.then-steps.ts Added a step definition to verify players' "cant-vote" attribute assigned by the Scapegoat.
tests/acceptance/features/support/hooks.ts Removed explicit build directory configuration for the Cucumber runner.

Possibly related PRs

  • feat(nuxt): typecheck on hooks and ci #832: The changes in this PR involve the addition of a type-checking configuration and script, which could relate to the main PR's enhancements in the testing framework and configuration for the Scapegoat role, as both involve improving the development workflow and ensuring code quality.

Suggested labels

🚀 feature

Poem

In the meadow where rabbits play,
A Scapegoat's tale unfolds today.
With votes to ban and stories grand,
New paths of strategy, oh so planned!
Hops of joy, for changes bright,
In the game we leap, with pure delight! 🐇✨


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 519571e and 503f4a2.

Files ignored due to path filters (1)
  • tests/acceptance/screenshots/linux/Survivors elect Sheriff Playground.png is excluded by !**/*.png
Files selected for processing (1)
  • tests/acceptance/features/game/features/role/scapegoat.feature (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tests/acceptance/features/game/features/role/scapegoat.feature

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 generate interesting stats about this repository and render them as a table.
    -- @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.

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.
Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for generating code suggestions in code reviews.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aacb761 and 519571e.

Files ignored due to path filters (1)
  • tests/acceptance/screenshots/darwin/Scapegoat bans voting Playground.png is excluded by !**/*.png
Files selected for processing (8)
  • .run/Scapegoat Role.run.xml (1 hunks)
  • modules/i18n/locales/en.json (2 hunks)
  • modules/i18n/locales/fr.json (1 hunks)
  • tests/acceptance/features/game/features/role/scapegoat.feature (1 hunks)
  • tests/acceptance/features/game/step-definitions/game-play/game-play.then-steps.ts (0 hunks)
  • tests/acceptance/features/game/step-definitions/game-play/game-play.when-steps.ts (1 hunks)
  • tests/acceptance/features/game/step-definitions/player/player-attribute/player-attribute.then-steps.ts (1 hunks)
  • tests/acceptance/features/support/hooks.ts (0 hunks)
Files not reviewed due to no reviewable changes (2)
  • tests/acceptance/features/game/step-definitions/game-play/game-play.then-steps.ts
  • tests/acceptance/features/support/hooks.ts
Files skipped from review due to trivial changes (1)
  • modules/i18n/locales/en.json
Additional comments not posted (13)
tests/acceptance/features/game/features/role/scapegoat.feature (9)

1-3: Feature correctly defined with appropriate tags.

The feature is appropriately tagged, and the description is clear and concise.


5-5: Scenario title is clear and descriptive.

The scenario title effectively describes the test case and its purpose.


6-12: Game setup is accurate with correct roles assigned.

The players and their respective roles are correctly specified, ensuring the scenario will function as intended.


14-16: Initial game events are properly handled.

Closing the toast and skipping all game events correctly transition the game to the "Survivors vote" phase.


18-24: Voting process accurately reflects game mechanics.

The votes result in a tie between Bob and Charlie, leading to the Scapegoat's death, which aligns with the game rules.


27-28: Event message correctly informs about the Scapegoat's ability.

The displayed text accurately describes the Scapegoat's revenge mechanic, and the player card shows the correct player.


30-33: Game transitions appropriately to Scapegoat's decision phase.

The game displays the correct title, question, and phase name, guiding the player through the Scapegoat's choice.


34-39: Potential targets are correctly listed for the Scapegoat.

All eligible players are presented as targets for the Scapegoat to ban from voting.


41-46: Scapegoat's ban action is correctly executed and validated.

The Scapegoat bans Bob from voting, and the game state reflects this action accurately.

tests/acceptance/features/game/step-definitions/game-play/game-play.when-steps.ts (1)

152-155: LGTM!

The new step definition for the scapegoat banning players from voting is correctly implemented and follows the established patterns.

tests/acceptance/features/game/step-definitions/player/player-attribute/player-attribute.then-steps.ts (2)

199-204: The New Step Definition Aligns with Existing Patterns

The added step definition correctly implements the acceptance test for verifying the "cant-vote" attribute assigned by the Scapegoat to multiple players. The usage of DataTable and the loop construct is consistent with existing step definitions.


202-202: Verify the Accuracy of the Attribute Description String

Ensure that the attribute description "The Scapegoat decided that this player can't vote." matches exactly with the application's UI text or the expected attribute identifier. Any discrepancy might lead to the test failing due to a mismatch in the attribute search.

To confirm the attribute description, you can run the following script:

Verification successful

To further verify the consistency and uniqueness of the attribute description, let's perform additional searches in the codebase.


Based on our analysis, we can now generate the final response. The attribute description appears to be correct and consistent with the game's logic. However, to provide a complete verification, let's check the localization file for the exact wording.


Based on our thorough analysis, we can now provide the final response regarding the accuracy of the attribute description.

Attribute Description Verified: Consistent Usage Across Codebase

The attribute description "The Scapegoat decided that this player can't vote." has been verified as accurate and consistently used within the codebase. Our analysis found:

  • Exact string match in the test file.
  • Related concepts like "ScapegoatBansVoting" and "bannedFromVotes" in various parts of the code.
  • Consistent representation of the Scapegoat's ability to ban voting.

While we couldn't locate a specific localization key for this string, its consistent usage suggests it's the correct attribute description.

Suggestion for future improvement: Consider making this attribute description a localized string for easier maintenance and potential translations.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the attribute description matches the expected string in the codebase.

# Test: Search for the exact attribute string used by the Scapegoat role.
# Expected Result: The string should be found in the relevant source files.

rg --type js --type ts $'The Scapegoat decided that this player can\'t vote\.' -A 5

Length of output: 725


Script:

#!/bin/bash
# Search for partial matches of the Scapegoat attribute description
rg --type js --type ts "Scapegoat.*vote" -i

# Search for the implementation of the Scapegoat role
ast-grep --lang typescript --pattern 'class $_ implements Role {
  $$$
  name = "Scapegoat"
  $$$
}'

Length of output: 4842


Script:

#!/bin/bash
# Search for the localization key related to Scapegoat banning votes
rg --type json '"components.GameOverHistoryRecordAction.bannedFromVotes"'

Length of output: 75

modules/i18n/locales/fr.json (1)

1355-1355: LGTM!

The updated string adds narrative depth to the Scapegoat's action without introducing any issues.

Copy link

sonarcloud bot commented Sep 17, 2024

@antoinezanardi antoinezanardi merged commit add895e into develop Sep 17, 2024
16 checks passed
@antoinezanardi antoinezanardi deleted the test/scapegoat-acceptance-tests branch September 17, 2024 13:35
antoinezanardi pushed a commit that referenced this pull request Sep 18, 2024
## [1.32.0](v1.31.0...v1.32.0) (2024-09-18)

### 🚀 Features

* **audio:** audio settings in local storage ([#831](#831)) ([cd8a2cb](cd8a2cb))
* **game-lobby:** all game lobby is responsive ([#877](#877)) ([aaccf38](aaccf38))
* **game-lobby:** auto-focus on player name input ([#860](#860)) ([7897da3](7897da3))
* **game-lobby:** auto-focus on player name input even after changing page ([#873](#873)) ([3bb8401](3bb8401))
* **game-lobby:** display disclaimer for small screens ([#853](#853)) ([81029b8](81029b8))
* **game-lobby:** game options confirm step in lobby ([#845](#845)) ([20cc2ce](20cc2ce))
* **game:** all game screens are responsive ([#880](#880)) ([b54b1dc](b54b1dc))
* **game:** game over screens are responsive ([#883](#883)) ([aacb761](aacb761))
* **misc-pages:** responsive for canceled game and not found game pages ([#888](#888)) ([deeb7b2](deeb7b2))
* **nuxt:** set route announcer ([#835](#835)) ([dd1115f](dd1115f))
* **nuxt:** typecheck on hooks and ci ([#832](#832)) ([794157f](794157f))

### 🐛 Bug Fixes

* **deps:** update dependency @primevue/themes to ^4.0.6 ([#842](#842)) ([4d3e063](4d3e063))
* **deps:** update dependency @primevue/themes to ^4.0.7 ([#855](#855)) ([2b80485](2b80485))
* **deps:** update dependency primevue to ^4.0.6 ([#843](#843)) ([3a20f01](3a20f01))
* **deps:** update dependency primevue to ^4.0.7 ([#856](#856)) ([6c75a61](6c75a61))
* **game-events:** icon animation null instance handler ([#889](#889)) ([ee0a17e](ee0a17e))
* **pwa:** remove redirect fallback ([#830](#830)) ([69c2c21](69c2c21))

### 🔩 Refactor

* **primevue:** use new accordion component ([#834](#834)) ([f611995](f611995))
* **primevue:** use new tab components ([#836](#836)) ([4f9c1b9](4f9c1b9))

### ✅ Tests

* **scapegoat:** acceptance tests ([#884](#884)) ([add895e](add895e))

### 🔁 CI

* **node:** use last node version in ci ([#848](#848)) ([aa047b3](aa047b3))

### 🧹 Chore

* **deps:** update commitlint monorepo to ^19.5.0 ([#852](#852)) ([cefe4af](cefe4af))
* **deps:** update dependency @cucumber/cucumber to ^11.0.1 ([#869](#869)) ([c00d3e7](c00d3e7))
* **deps:** update dependency @cucumber/cucumber to v11 ([#817](#817)) ([dcbad46](dcbad46))
* **deps:** update dependency @faker-js/faker to ^9.0.1 ([#870](#870)) ([da15f7c](da15f7c))
* **deps:** update dependency @nuxt/test-utils to ^3.14.2 ([#846](#846)) ([f0f715a](f0f715a))
* **deps:** update dependency @nuxtjs/i18n to ^8.5.2 ([#764](#764)) ([0fe9bf0](0fe9bf0))
* **deps:** update dependency @nuxtjs/i18n to ^8.5.3 ([#849](#849)) ([1689312](1689312))
* **deps:** update dependency @nuxtjs/robots to ^4.1.7 ([#861](#861)) ([4cf88c8](4cf88c8))
* **deps:** update dependency @primevue/nuxt-module to ^4.0.6 ([#841](#841)) ([7384c1e](7384c1e))
* **deps:** update dependency @primevue/nuxt-module to ^4.0.7 ([#854](#854)) ([22c3f4a](22c3f4a))
* **deps:** update dependency @stylistic/eslint-plugin to ^2.8.0 ([#838](#838)) ([1c15410](1c15410))
* **deps:** update dependency @types/qs to ^6.9.16 ([#868](#868)) ([8560a5d](8560a5d))
* **deps:** update dependency @vueuse/core to ^11.1.0 ([#875](#875)) ([b568680](b568680))
* **deps:** update dependency @vueuse/nuxt to ^11.1.0 ([#876](#876)) ([0f358b6](0f358b6))
* **deps:** update dependency circle-progress.vue to ^3.2.2 ([#878](#878)) ([4cd09ac](4cd09ac))
* **deps:** update dependency husky to ^9.1.6 ([#858](#858)) ([03b278b](03b278b))
* **deps:** update dependency msw to ^2.4.3 ([#827](#827)) ([6cd07ef](6cd07ef))
* **deps:** update dependency msw to ^2.4.4 ([#833](#833)) ([44814db](44814db))
* **deps:** update dependency msw to ^2.4.5 ([#850](#850)) ([773674a](773674a))
* **deps:** update dependency msw to ^2.4.6 ([#864](#864)) ([93b4a45](93b4a45))
* **deps:** update dependency msw to ^2.4.7 ([#871](#871)) ([b6cef68](b6cef68))
* **deps:** update dependency msw to ^2.4.8 ([#882](#882)) ([96d9d56](96d9d56))
* **deps:** update dependency node to v22.9.0 ([#886](#886)) ([8f28e99](8f28e99))
* **deps:** update dependency sass to ^1.79.1 ([#887](#887)) ([02e728a](02e728a))
* **deps:** update dependency semantic-release to ^24.1.1 ([#851](#851)) ([9a5d974](9a5d974))
* **deps:** update dependency tailwindcss to ^3.4.11 ([#857](#857)) ([74668ab](74668ab))
* **deps:** update dependency tailwindcss to ^3.4.12 ([#885](#885)) ([b2d182d](b2d182d))
* **deps:** update dependency tsx to ^4.19.1 ([#859](#859)) ([6e771c3](6e771c3))
* **deps:** update dependency type-fest to ^4.26.1 ([#829](#829)) ([7b715fd](7b715fd))
* **deps:** update dependency typescript to ^5.6.2 ([#839](#839)) ([69b99b1](69b99b1))
* **deps:** update dependency vue to ^3.5.4 ([#844](#844)) ([09fd254](09fd254))
* **deps:** update dependency vue to ^3.5.5 ([#865](#865)) ([13ae2b7](13ae2b7))
* **deps:** update dependency vue to ^3.5.6 ([#874](#874)) ([77302a2](77302a2))
* **deps:** update dependency vue-router to ^4.4.4 ([#847](#847)) ([23430aa](23430aa))
* **deps:** update dependency vue-router to ^4.4.5 ([#863](#863)) ([28a6c29](28a6c29))
* **deps:** update nuxtjs monorepo to ^3.13.2 ([#872](#872)) ([28e0e43](28e0e43))
* **deps:** update playwright monorepo to ^1.47.1 ([#866](#866)) ([ae9e014](ae9e014))
* **deps:** update pnpm to v9.10.0 ([#837](#837)) ([05be262](05be262))
* **deps:** update typescript-eslint monorepo to ^8.5.0 ([#840](#840)) ([b230013](b230013))
* **deps:** update typescript-eslint monorepo to ^8.6.0 ([#881](#881)) ([c291635](c291635))
* **deps:** update vitest monorepo to ^2.1.0 ([#862](#862)) ([b25b312](b25b312))
* **deps:** update vitest monorepo to ^2.1.1 ([#867](#867)) ([a1ad2f8](a1ad2f8))
* **screenshots:** missing screenshots for linux ([8bfa635](8bfa635))
@antoinezanardi
Copy link
Owner Author

🎉 This PR is included in version 1.32.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released ✅ test Adding missing tests or correcting existing tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant