ci: setup codecov coverage & badge

.config/nextest.toml

@@ -3,10 +3,3 @@ fail-fast = false
 
 [profile.coverage]
 status-level = "none"
-
-[[profile.default.overrides]]
-filter = 'test(pacman::game::)'
-test-group = 'serial'
-
-[test-groups]
-serial = { max-threads = 1 }

.github/workflows/coverage.yaml

@@ -4,11 +4,13 @@ on: ["push", "pull_request"]
 
 env:
   CARGO_TERM_COLOR: always
-  RUST_TOOLCHAIN: nightly
+  RUST_TOOLCHAIN: 1.86.0
 
 jobs:
   coverage:
     runs-on: ubuntu-latest
+    env:
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v5
@@ -46,11 +48,41 @@ jobs:
 
       - name: Generate coverage report
         run: |
-          just coverage-lcov
+          just coverage
 
-      - name: Coveralls upload
-        uses: coverallsapp/github-action@v2
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
         with:
-          github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
-          path-to-lcov: lcov.info
-          debug: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: lcov.info
+
+      - name: Download Coveralls CLI
+        if: ${{ env.COVERALLS_REPO_TOKEN != '' }}
+        run: |
+          # use GitHub Releases URL instead of coveralls.io because they can't maintain their own files; it 404s
+          curl -L https://github.com/coverallsapp/coverage-reporter/releases/download/v0.6.15/coveralls-linux-x86_64.tar.gz | tar -xz -C /usr/local/bin
+
+      - name: Upload coverage to Coveralls
+        if: ${{ env.COVERALLS_REPO_TOKEN != '' }}
+        run: |
+          if [ ! -f "lcov.info" ]; then
+            echo "Error: lcov.info file not found. Coverage generation may have failed."
+            exit 1
+          fi
+
+          for i in {1..10}; do
+            echo "Attempt $i: Uploading coverage to Coveralls..."
+            if coveralls -n report lcov.info; then
+              echo "Successfully uploaded coverage report."
+              exit 0
+            fi
+
+            if [ $i -lt 10 ]; then
+              delay=$((2**i))
+              echo "Attempt $i failed. Retrying in $delay seconds..."
+              sleep $delay
+            fi
+          done
+
+          echo "Failed to upload coverage report after 10 attempts."
+          exit 1

.gitignore

@@ -14,13 +14,8 @@ assets/site/build.css
 
 # Coverage reports
 lcov.info
-codecov.json
 coverage.html
 
 # Profiling output
 flamegraph.svg
 /profile.*
-
-# temporary
-assets/game/sound/*.wav
-/*.py

Cargo.lock

@@ -663,7 +663,7 @@ checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d"
 
 [[package]]
 name = "pacman"
-version = "0.76.1"
+version = "0.2.0"
 dependencies = [
  "anyhow",
  "bevy_ecs",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pacman"
-version = "0.76.1"
+version = "0.2.0"
 authors = ["Xevion"]
 edition = "2021"
 rust-version = "1.86.0"
@@ -98,6 +98,3 @@ x86_64-pc-windows-msvc = { triplet = "x64-windows-static-md" }
 x86_64-unknown-linux-gnu = { triplet = "x64-linux" }
 x86_64-apple-darwin = { triplet = "x64-osx" }
 aarch64-apple-darwin = { triplet = "arm64-osx" }
-
-[lints.rust]
-unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage,coverage_nightly)'] }

Justfile

@@ -1,6 +1,9 @@
 set shell := ["bash", "-c"]
 set windows-shell := ["powershell.exe", "-NoLogo", "-Command"]
 
+# Regex to exclude files from coverage report, double escapes for Justfile + CLI
+# You can use src\\\\..., but the filename alone is acceptable too
+coverage_exclude_pattern := "src\\\\app\\.rs|audio\\.rs|src\\\\error\\.rs|platform\\\\emscripten\\.rs|bin\\\\.+\\.rs|main\\.rs|platform\\\\desktop\\.rs|platform\\\\tracing_buffer\\.rs|platform\\\\buffered_writer\\.rs|systems\\\\debug\\.rs|systems\\\\profiling\\.rs"
 
 binary_extension := if os() == "windows" { ".exe" } else { "" }
 
@@ -11,19 +14,22 @@ binary_extension := if os() == "windows" { ".exe" } else { "" }
 html: coverage
     cargo llvm-cov report \
     --remap-path-prefix \
+    --ignore-filename-regex "{{ coverage_exclude_pattern }}" \
     --html \
     --open
 
 # Display report (for humans)
 report-coverage: coverage
-    cargo llvm-cov report --remap-path-prefix
+    cargo llvm-cov report \
+    --remap-path-prefix \
+    --ignore-filename-regex "{{ coverage_exclude_pattern }}"
 
-# Run & generate LCOV report (as base report)
+# Run & generate report (for CI)
 coverage:
-    cargo +nightly llvm-cov \
+    cargo llvm-cov \
     --lcov \
     --remap-path-prefix \
-    --workspace \
+    --ignore-filename-regex "{{ coverage_exclude_pattern }}" \
     --output-path lcov.info \
     --profile coverage \
     --no-fail-fast nextest

codecov.yml

@@ -1,3 +0,0 @@
-ignore:
-  - "src/(?:bin|platform))/.+\\.rs"
-  - "src/(?:app|events|formatter)\\.rs"

src/asset.rs

@@ -19,8 +19,6 @@ pub enum Asset {
     AtlasImage,
     /// Terminal Vector font for text rendering (TerminalVector.ttf)
     Font,
-    /// Sound effect for Pac-Man's death
-    DeathSound,
 }
 
 impl Asset {
@@ -39,7 +37,6 @@ impl Asset {
             Wav4 => "sound/waka/4.ogg",
             AtlasImage => "atlas.png",
             Font => "TerminalVector.ttf",
-            DeathSound => "sound/pacman_death.wav",
         }
     }
 }

src/audio.rs

@@ -16,7 +16,6 @@ const SOUND_ASSETS: [Asset; 4] = [Asset::Wav1, Asset::Wav2, Asset::Wav3, Asset::
 pub struct Audio {
     _mixer_context: Option<mixer::Sdl2MixerContext>,
     sounds: Vec<Chunk>,
-    death_sound: Option<Chunk>,
     next_sound_index: usize,
     muted: bool,
     disabled: bool,
@@ -45,7 +44,6 @@ impl Audio {
             return Self {
                 _mixer_context: None,
                 sounds: Vec::new(),
-                death_sound: None,
                 next_sound_index: 0,
                 muted: false,
                 disabled: true,
@@ -67,7 +65,6 @@ impl Audio {
                 return Self {
                     _mixer_context: None,
                     sounds: Vec::new(),
-                    death_sound: None,
                     next_sound_index: 0,
                     muted: false,
                     disabled: true,
@@ -96,33 +93,12 @@ impl Audio {
             }
         }
 
-        let death_sound = match get_asset_bytes(Asset::DeathSound) {
-            Ok(data) => match RWops::from_bytes(&data) {
-                Ok(rwops) => match rwops.load_wav() {
-                    Ok(chunk) => Some(chunk),
-                    Err(e) => {
-                        tracing::warn!("Failed to load death sound from asset API: {}", e);
-                        None
-                    }
-                },
-                Err(e) => {
-                    tracing::warn!("Failed to create RWops for death sound: {}", e);
-                    None
-                }
-            },
-            Err(e) => {
-                tracing::warn!("Failed to load death sound asset: {}", e);
-                None
-            }
-        };
-
         // If no sounds loaded successfully, disable audio
-        if sounds.is_empty() && death_sound.is_none() {
+        if sounds.is_empty() {
             tracing::warn!("No sounds loaded successfully. Audio will be disabled.");
             return Self {
                 _mixer_context: Some(mixer_context),
                 sounds: Vec::new(),
-                death_sound: None,
                 next_sound_index: 0,
                 muted: false,
                 disabled: true,
@@ -132,7 +108,6 @@ impl Audio {
         Audio {
             _mixer_context: Some(mixer_context),
             sounds,
-            death_sound,
             next_sound_index: 0,
             muted: false,
             disabled: false,
@@ -163,24 +138,6 @@ impl Audio {
         self.next_sound_index = (self.next_sound_index + 1) % self.sounds.len();
     }
 
-    /// Plays the death sound effect.
-    pub fn death(&mut self) {
-        if self.disabled || self.muted {
-            return;
-        }
-
-        if let Some(chunk) = &self.death_sound {
-            mixer::Channel::all().play(chunk, 0).ok();
-        }
-    }
-
-    /// Halts all currently playing audio channels.
-    pub fn stop_all(&mut self) {
-        if !self.disabled {
-            mixer::Channel::all().halt();
-        }
-    }
-
     /// Instantly mutes or unmutes all audio channels by adjusting their volume.
     ///
     /// Sets all 4 mixer channels to zero volume when muting, or restores them to

src/bin/aspect_demo.rs

@@ -1,6 +1,3 @@
-#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
-#![cfg_attr(coverage_nightly, coverage(off))]
-
 use std::time::{Duration, Instant};
 
 use sdl2::event::Event;

src/bin/timing_demo.rs

@@ -1,6 +1,3 @@
-#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
-#![cfg_attr(coverage_nightly, coverage(off))]
-
 use circular_buffer::CircularBuffer;
 use pacman::constants::CANVAS_SIZE;
 use sdl2::event::Event;

src/lib.rs

@@ -1,22 +1,14 @@
 //! Pac-Man game library crate.
-#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
 
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub mod app;
-#[cfg_attr(coverage_nightly, coverage(off))]
-pub mod audio;
-#[cfg_attr(coverage_nightly, coverage(off))]
-pub mod error;
-#[cfg_attr(coverage_nightly, coverage(off))]
-pub mod events;
-#[cfg_attr(coverage_nightly, coverage(off))]
-pub mod formatter;
-#[cfg_attr(coverage_nightly, coverage(off))]
-pub mod platform;
-
 pub mod asset;
+pub mod audio;
 pub mod constants;
+pub mod error;
+pub mod events;
+pub mod formatter;
 pub mod game;
 pub mod map;
+pub mod platform;
 pub mod systems;
 pub mod texture;

src/main.rs

@@ -1,27 +1,20 @@
 // Note: This disables the console window on Windows. We manually re-attach to the parent terminal or process later on.
 #![windows_subsystem = "windows"]
-#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
 
 use crate::{app::App, constants::LOOP_TIME};
 use tracing::info;
 
-#[cfg_attr(coverage_nightly, coverage(off))]
 mod app;
-#[cfg_attr(coverage_nightly, coverage(off))]
-mod audio;
-#[cfg_attr(coverage_nightly, coverage(off))]
-mod error;
-#[cfg_attr(coverage_nightly, coverage(off))]
-mod events;
-#[cfg_attr(coverage_nightly, coverage(off))]
-mod formatter;
-#[cfg_attr(coverage_nightly, coverage(off))]
-mod platform;
-
 mod asset;
+mod audio;
 mod constants;
+
+mod error;
+mod events;
+mod formatter;
 mod game;
 mod map;
+mod platform;
 mod systems;
 mod texture;
 
@@ -29,7 +22,6 @@ mod texture;
 ///
 /// This function initializes SDL, the window, the game state, and then enters
 /// the main game loop.
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub fn main() {
     // On Windows, this connects output streams to the console dynamically
     // On Emscripten, this connects the subscriber to the browser console

src/platform/desktop.rs

@@ -65,7 +65,6 @@ pub fn get_asset_bytes(asset: Asset) -> Result<Cow<'static, [u8]>, AssetError> {
         Asset::Wav4 => Ok(Cow::Borrowed(include_bytes!("../../assets/game/sound/waka/4.ogg"))),
         Asset::AtlasImage => Ok(Cow::Borrowed(include_bytes!("../../assets/game/atlas.png"))),
         Asset::Font => Ok(Cow::Borrowed(include_bytes!("../../assets/game/TerminalVector.ttf"))),
-        Asset::DeathSound => Ok(Cow::Borrowed(include_bytes!("../../assets/game/sound/pacman_death.wav"))),
     }
 }
 

src/systems/audio.rs

@@ -26,10 +26,6 @@ pub struct AudioState {
 pub enum AudioEvent {
     /// Play the "eat" sound when Pac-Man consumes a pellet
     PlayEat,
-    /// Play the death sound
-    PlayDeath,
-    /// Stop all currently playing sounds
-    StopAll,
 }
 
 /// Non-send resource wrapper for SDL2 audio system
@@ -63,16 +59,6 @@ pub fn audio_system(
                     // 4 eat sounds available
                 }
             }
-            AudioEvent::PlayDeath => {
-                if !audio.0.is_disabled() && !audio_state.muted {
-                    audio.0.death();
-                }
-            }
-            AudioEvent::StopAll => {
-                if !audio.0.is_disabled() {
-                    audio.0.stop_all();
-                }
-            }
         }
     }
 }

src/systems/debug.rs

@@ -1,5 +1,6 @@
 //! Debug rendering system
-#[cfg_attr(coverage_nightly, feature(coverage_attribute))]
+use std::cmp::Ordering;
+
 use crate::constants::{self, BOARD_PIXEL_OFFSET};
 use crate::map::builder::Map;
 use crate::systems::{Collider, CursorPosition, NodeId, Position, SystemTimings};
@@ -12,7 +13,6 @@ use sdl2::rect::{Point, Rect};
 use sdl2::render::{Canvas, Texture};
 use sdl2::video::Window;
 use smallvec::SmallVec;
-use std::cmp::Ordering;
 use std::collections::{HashMap, HashSet};
 use tracing::warn;
 
@@ -149,7 +149,6 @@ fn transform_position_with_offset(pos: Vec2, scale: f32) -> IVec2 {
 }
 
 /// Renders timing information in the top-left corner of the screen using the debug text atlas
-#[cfg_attr(coverage_nightly, coverage(off))]
 fn render_timing_display(
     canvas: &mut Canvas<Window>,
     timings: &SystemTimings,
@@ -204,7 +203,6 @@ fn render_timing_display(
 }
 
 #[allow(clippy::too_many_arguments)]
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub fn debug_render_system(
     canvas: &mut Canvas<Window>,
     ttf_atlas: &mut TtfAtlasResource,
@@ -268,7 +266,7 @@ pub fn debug_render_system(
     }
 
     canvas.set_draw_color(Color {
-        a: f32_to_u8(0.65),
+        a: f32_to_u8(0.6),
         ..Color::RED
     });
     canvas.set_blend_mode(sdl2::render::BlendMode::Blend);

src/systems/mod.rs

@@ -3,21 +3,17 @@
 //! This module contains all the ECS-related logic, including components, systems,
 //! and resources.
 
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub mod audio;
 pub mod blinking;
 pub mod collision;
 pub mod components;
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub mod debug;
 pub mod ghost;
 pub mod input;
 pub mod item;
 pub mod movement;
 pub mod player;
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub mod profiling;
-#[cfg_attr(coverage_nightly, coverage(off))]
 pub mod render;
 pub mod stage;
 

src/texture/sprites.rs

@@ -15,8 +15,6 @@ pub enum PacmanSprite {
     Moving(Direction, u8),
     /// The full, closed-mouth Pac-Man sprite.
     Full,
-    /// A single frame of the dying animation.
-    Dying(u8),
 }
 
 /// Represents the color of a frightened ghost.
@@ -62,50 +60,45 @@ impl GameSprite {
     /// This path corresponds to the filename in the texture atlas JSON file.
     pub fn to_path(self) -> String {
         match self {
-            GameSprite::Pacman(PacmanSprite::Moving(dir, frame)) => format!(
-                "pacman/{}_{}.png",
-                dir.as_ref(),
-                match frame {
-                    0 => "a",
-                    1 => "b",
-                    _ => panic!("Invalid animation frame"),
+            GameSprite::Pacman(sprite) => match sprite {
+                PacmanSprite::Moving(dir, frame) => {
+                    let frame_char = match frame {
+                        0 => 'a',
+                        1 => 'b',
+                        _ => panic!("Invalid animation frame"),
+                    };
+                    format!("pacman/{}_{}.png", dir.as_ref().to_lowercase(), frame_char)
                 }
-            ),
-            GameSprite::Pacman(PacmanSprite::Full) => "pacman/full.png".to_string(),
-            GameSprite::Pacman(PacmanSprite::Dying(frame)) => format!("pacman/death/{}.png", frame),
-
-            // Ghost sprites
-            GameSprite::Ghost(GhostSprite::Normal(ghost_type, dir, frame)) => {
-                let frame_char = match frame {
-                    0 => 'a',
-                    1 => 'b',
-                    _ => panic!("Invalid animation frame"),
-                };
-                format!(
-                    "ghost/{}/{}_{}.png",
-                    ghost_type.as_str(),
-                    dir.as_ref().to_lowercase(),
-                    frame_char
-                )
-            }
-            GameSprite::Ghost(GhostSprite::Frightened(color, frame)) => {
-                let frame_char = match frame {
-                    0 => 'a',
-                    1 => 'b',
-                    _ => panic!("Invalid animation frame"),
-                };
-                let color_str = match color {
-                    FrightenedColor::Blue => "blue",
-                    FrightenedColor::White => "white",
-                };
-                format!("ghost/frightened/{}_{}.png", color_str, frame_char)
-            }
-            GameSprite::Ghost(GhostSprite::Eyes(dir)) => format!("ghost/eyes/{}.png", dir.as_ref().to_lowercase()),
-
-            // Maze sprites
-            GameSprite::Maze(MazeSprite::Tile(index)) => format!("maze/tiles/{}.png", index),
-            GameSprite::Maze(MazeSprite::Pellet) => "maze/pellet.png".to_string(),
-            GameSprite::Maze(MazeSprite::Energizer) => "maze/energizer.png".to_string(),
+                PacmanSprite::Full => "pacman/full.png".to_string(),
+            },
+            GameSprite::Ghost(sprite) => match sprite {
+                GhostSprite::Normal(ghost, dir, frame) => {
+                    let frame_char = match frame {
+                        0 => 'a',
+                        1 => 'b',
+                        _ => panic!("Invalid animation frame"),
+                    };
+                    format!("ghost/{}/{}_{}.png", ghost.as_str(), dir.as_ref().to_lowercase(), frame_char)
+                }
+                GhostSprite::Frightened(color, frame) => {
+                    let frame_char = match frame {
+                        0 => 'a',
+                        1 => 'b',
+                        _ => panic!("Invalid animation frame"),
+                    };
+                    let color_str = match color {
+                        FrightenedColor::Blue => "blue",
+                        FrightenedColor::White => "white",
+                    };
+                    format!("ghost/frightened/{}_{}.png", color_str, frame_char)
+                }
+                GhostSprite::Eyes(dir) => format!("ghost/eyes/{}.png", dir.as_ref().to_lowercase()),
+            },
+            GameSprite::Maze(sprite) => match sprite {
+                MazeSprite::Tile(index) => format!("maze/tiles/{}.png", index),
+                MazeSprite::Pellet => "maze/pellet.png".to_string(),
+                MazeSprite::Energizer => "maze/energizer.png".to_string(),
+            },
         }
     }
 }

tests/sprites.rs

@@ -1,73 +0,0 @@
-//! Tests for the sprite path generation.
-use pacman::{
-    game::ATLAS_FRAMES,
-    map::direction::Direction,
-    systems::components::Ghost,
-    texture::sprites::{FrightenedColor, GameSprite, GhostSprite, MazeSprite, PacmanSprite},
-};
-
-#[test]
-fn test_all_sprite_paths_exist() {
-    let mut sprites_to_test = Vec::new();
-
-    // Pac-Man sprites
-    for &dir in &[Direction::Up, Direction::Down, Direction::Left, Direction::Right] {
-        for frame in 0..2 {
-            sprites_to_test.push(GameSprite::Pacman(PacmanSprite::Moving(dir, frame)));
-        }
-    }
-    sprites_to_test.push(GameSprite::Pacman(PacmanSprite::Full));
-    for frame in 0..=10 {
-        sprites_to_test.push(GameSprite::Pacman(PacmanSprite::Dying(frame)));
-    }
-
-    // Ghost sprites
-    for &ghost in &[Ghost::Blinky, Ghost::Pinky, Ghost::Inky, Ghost::Clyde] {
-        for &dir in &[Direction::Up, Direction::Down, Direction::Left, Direction::Right] {
-            for frame in 0..2 {
-                sprites_to_test.push(GameSprite::Ghost(GhostSprite::Normal(ghost, dir, frame)));
-            }
-            sprites_to_test.push(GameSprite::Ghost(GhostSprite::Eyes(dir)));
-        }
-    }
-    for &color in &[FrightenedColor::Blue, FrightenedColor::White] {
-        for frame in 0..2 {
-            sprites_to_test.push(GameSprite::Ghost(GhostSprite::Frightened(color, frame)));
-        }
-    }
-
-    // Maze sprites
-    for i in 0..=34 {
-        sprites_to_test.push(GameSprite::Maze(MazeSprite::Tile(i)));
-    }
-    sprites_to_test.push(GameSprite::Maze(MazeSprite::Pellet));
-    sprites_to_test.push(GameSprite::Maze(MazeSprite::Energizer));
-
-    for sprite in sprites_to_test {
-        let path = sprite.to_path();
-        assert!(
-            ATLAS_FRAMES.contains_key(&path),
-            "Sprite path '{}' does not exist in the atlas.",
-            path
-        );
-    }
-}
-
-#[test]
-fn test_invalid_sprite_paths_do_not_exist() {
-    let invalid_sprites = vec![
-        // An invalid Pac-Man dying frame
-        GameSprite::Pacman(PacmanSprite::Dying(99)),
-        // An invalid maze tile
-        GameSprite::Maze(MazeSprite::Tile(99)),
-    ];
-
-    for sprite in invalid_sprites {
-        let path = sprite.to_path();
-        assert!(
-            !ATLAS_FRAMES.contains_key(&path),
-            "Invalid sprite path '{}' was found in the atlas, but it should not exist.",
-            path
-        );
-    }
-}