[BUG] Tests fail on MacOS

[FliegendeWurst]

Describe the bug
Test suite fails due to different key names on MacOS.

To Reproduce
Steps to reproduce the behavior:

1. Run cargo test on MacOS

Expected behavior
Test suite passes

Screenshots

---- ui::draw_blocks::help::tests::test_draw_blocks_help_one_and_two_definitions stdout ----
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Snapshot Summary ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Snapshot file: src/ui/draw_blocks/snapshots/oxker__ui__draw_blocks__help__tests__draw_blocks_help_one_and_two_definitions.snap
Snapshot: draw_blocks_help_one_and_two_definitions
Source: src/ui/draw_blocks/help.rs:689
────────────────────────────────────────────────────────────────────────────────
Expression: setup.terminal.backend()
────────────────────────────────────────────────────────────────────────────────
-old snapshot
+new results
────────────┬───────────────────────────────────────────────────────────────────
   33    33 │ " │ ( # ) sort containers by memory                                                                          │ "
   34    34 │ " │ ( / ) or ( = ) sort containers by id                                                                     │ "
   35    35 │ " │ ( , ) sort containers by image                                                                           │ "
   36    36 │ " │ ( . ) or ( ] ) sort containers by rx                                                                     │ "
   37       │-" │ ( Backspace ) sort containers by tx                                                                      │ "
         37 │+" │ ( Delete ) sort containers by tx                                                                         │ "
   38    38 │ " │ ( a ) or ( b ) close dialog                                                                              │ "
   39    39 │ " │ ( k ) quit at any time                                                                                   │ "
   40    40 │ " │                                                                                                          │ "
   41    41 │ " │                    currently an early work in progress, all and any input appreciated                    │ "
────────────┴───────────────────────────────────────────────────────────────────

Two other test fail similarly

failures:
    ui::draw_blocks::help::tests::test_draw_blocks_help_custom_keymap_one_definition
    ui::draw_blocks::help::tests::test_draw_blocks_help_custom_keymap_two_definitions
    ui::draw_blocks::help::tests::test_draw_blocks_help_one_and_two_definitions

Desktop:

• OS: MacOS, probably a fairly recent version

Additional context
This issue was caught as part of the regular CI run over at nixpkgs NixOS/nixpkgs#400342

[mrjackwills]

Thanks, I suspect this is an issue related to Backspace on MacOS working differently to on Linux/Windows.

By default, oxker doesn't use the Backspace or Delete button it its keymap, so in order to fix this we can just change this test to use a different key?

[mrjackwills]

There's a branch called test/backspace_macos that should hopefully now have passing tests. I don't have an MacOS machine at the moment, so if there's any chance you could confirm it, that would be much appreciated, no rush though

[FliegendeWurst]

I still see:

---- ui::draw_blocks::help::tests::test_draw_blocks_help_custom_keymap_two_definitions stdout ----
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Snapshot Summary ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Snapshot file: src/ui/draw_blocks/snapshots/oxker__ui__draw_blocks__help__tests__draw_blocks_help_custom_keymap_two_definitions.snap
Snapshot: draw_blocks_help_custom_keymap_two_definitions
Source: src/ui/draw_blocks/help.rs:642
─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
Expression: setup.terminal.backend()
─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
-old snapshot
+new results
────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   20    20 │ " │ ( s ) or ( t ) scroll list to end                                                                        │ "
   21    21 │ " │ ( u ) or ( v ) scroll list to start                                                                      │ "
   22    22 │ " │ ( enter ) send docker container command                                                                  │ "
   23    23 │ " │ ( g ) or ( h ) exec into a container                                                                     │ "
   24       │-" │ ( Home ) or ( Del ) toggle this help information - or click heading                                      │ "
         24 │+" │ ( Home ) or ( Fwd Del ) toggle this help information - or click heading                                  │ "
   25    25 │ " │ ( m ) or ( n ) save logs to file                                                                         │ "
   26    26 │ " │ ( Page Down ) or ( Page Up ) toggle mouse capture - if disabled, text on screen can be selected & copied │ "
   27    27 │ " │ ( i ) or ( j ) enter filter mode                                                                         │ "
   28    28 │ " │ ( Up ) or ( Down ) reset container sorting                                                               │ "
────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
To update snapshots run `cargo insta review`
Stopped on the first failure. Run `cargo insta test` to run all snapshots.

thread 'ui::draw_blocks::help::tests::test_draw_blocks_help_custom_keymap_two_definitions' panicked at /Users/fliegendewurst/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/insta-1.42.2/src/runtime.rs:679:13:
snapshot assertion for 'draw_blocks_help_custom_keymap_two_definitions' failed in line 642
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace


failures:
    ui::draw_blocks::help::tests::test_draw_blocks_help_custom_keymap_two_definitions

This is also in the CI log linked, I must have overlooked it when copying the relevant parts in the bug report.

[mrjackwills]

Argh, another key that MacOS handles differently

[FliegendeWurst]

New commit passes all tests 👍

[mrjackwills]

@FliegendeWurst Is this holding back the release of a MacOS packaged version of oxker? As in do you need a new release with the fixed tests asap?

[FliegendeWurst]

It would be good, yes. Tests must pass for the package to finish building.