From 13b602ee3f3bf602acd3ea871f8da3771600c4e7 Mon Sep 17 00:00:00 2001
From: Nathan Stocks <cleancut@github.com>
Date: Mon, 22 Feb 2021 08:42:19 +0000
Subject: [PATCH] Xtask CI (#1387)

This PR is easiest to review commit by commit.

Followup on https://github.com/bevyengine/bevy/pull/1309#issuecomment-767310084

- [x] Switch from a bash script to an xtask rust workspace member.
  - Results in ~30s longer CI due to compilation of the xtask itself
  - Enables Bevy contributors on any platform to run `cargo ci` to run linting -- if the default available Rust is the same version as on CI, then the command should give an identical result.
- [x] Use the xtask from official CI so there's only one place to update.
- [x] Bonus: Run clippy on the _entire_ workspace (existing CI setup was missing the `--workspace` flag
  - [x] Clean up newly-exposed clippy errors

~#1388 builds on this to clean up newly discovered clippy errors -- I thought it might be nicer as a separate PR.~  Nope, merged it into this one so CI would pass.

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
---
 .cargo/config_fast_builds                     |  2 +-
 .github/workflows/ci.yml                      |  9 ++-------
 Cargo.toml                                    |  2 +-
 benches/benches/bevy_ecs/bench.rs             |  4 ++--
 crates/bevy_core/src/time/time.rs             |  1 +
 crates/bevy_core/src/time/timer.rs            |  1 +
 crates/bevy_ecs/src/core/serde.rs             |  2 +-
 crates/bevy_ecs/src/core/world.rs             |  3 +--
 crates/bevy_ecs/src/resource/resources.rs     | 14 ++++++-------
 crates/bevy_ecs/src/system/commands.rs        |  3 ++-
 crates/bevy_reflect/src/lib.rs                |  3 +++
 crates/bevy_reflect/src/path.rs               |  1 +
 .../render_resource_bindings.rs               |  8 ++++----
 crates/bevy_render/src/shader/shader.rs       |  6 +++---
 crates/bevy_tasks/src/task_pool.rs            |  1 +
 tools/ci                                      | 20 -------------------
 tools/ci/Cargo.toml                           | 13 ++++++++++++
 tools/ci/src/main.rs                          | 19 ++++++++++++++++++
 18 files changed, 63 insertions(+), 49 deletions(-)
 delete mode 100755 tools/ci
 create mode 100644 tools/ci/Cargo.toml
 create mode 100644 tools/ci/src/main.rs

diff --git a/.cargo/config_fast_builds b/.cargo/config_fast_builds
index d0d6eda4d8..f01e0a7c66 100644
--- a/.cargo/config_fast_builds
+++ b/.cargo/config_fast_builds
@@ -1,4 +1,4 @@
-# Rename this file to `config.toml` to enable "fast build" configuration. Please read the notes below.
+# Add the contents of this file to `config.toml` to enable "fast build" configuration. Please read the notes below.
 
 # NOTE: For maximum performance, build using a nightly compiler
 # If you are using rust stable, remove the "-Zshare-generics=y" below (as well as "-Csplit-debuginfo=unpacked" when building on macOS).
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 87b3291952..b1ce43cf87 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -34,13 +34,8 @@ jobs:
         if: runner.os == 'linux'
 
       - name: Check the format
-        run: cargo fmt --all -- --check
-        if: runner.os == 'linux' && matrix.toolchain == 'stable'
-
-      # -A clippy::type_complexity: type complexity must be ignored because we use huge templates for queries.
-      # -A clippy::manual-strip: strip_prefix support was added in 1.45. We want to support earlier rust versions.
-      - name: Clippy
-        run: cargo clippy --all-targets --all-features -- -D warnings -A clippy::type_complexity -A clippy::manual-strip
+        # See tools/ci/src/main.rs for the commands this runs
+        run: cargo run --package ci
         if: runner.os == 'linux' && matrix.toolchain == 'stable'
 
       - name: Build & run tests
diff --git a/Cargo.toml b/Cargo.toml
index 8b9df8c00f..719723e12d 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -17,7 +17,7 @@ repository = "https://github.com/bevyengine/bevy"
 
 [workspace]
 exclude = ["benches"]
-members = ["crates/*", "examples/ios"]
+members = ["crates/*", "examples/ios", "tools/ci"]
 
 [features]
 default = [
diff --git a/benches/benches/bevy_ecs/bench.rs b/benches/benches/bevy_ecs/bench.rs
index 4547af2a91..2af2f4a320 100644
--- a/benches/benches/bevy_ecs/bench.rs
+++ b/benches/benches/bevy_ecs/bench.rs
@@ -32,7 +32,7 @@ fn spawn_static(b: &mut Bencher) {
     struct Bundle {
         pos: Position,
         vel: Velocity,
-    };
+    }
 
     let mut world = World::new();
     b.iter(|| {
@@ -48,7 +48,7 @@ fn spawn_batch(b: &mut Bencher) {
     struct Bundle {
         pos: Position,
         vel: Velocity,
-    };
+    }
 
     let mut world = World::new();
     b.iter(|| {
diff --git a/crates/bevy_core/src/time/time.rs b/crates/bevy_core/src/time/time.rs
index d2f32411bc..670c6d3029 100644
--- a/crates/bevy_core/src/time/time.rs
+++ b/crates/bevy_core/src/time/time.rs
@@ -89,6 +89,7 @@ pub(crate) fn time_system(mut time: ResMut<Time>) {
 }
 
 #[cfg(test)]
+#[allow(clippy::float_cmp)]
 mod tests {
     use super::Time;
     use bevy_utils::{Duration, Instant};
diff --git a/crates/bevy_core/src/time/timer.rs b/crates/bevy_core/src/time/timer.rs
index fbb15acf39..ea634850c7 100644
--- a/crates/bevy_core/src/time/timer.rs
+++ b/crates/bevy_core/src/time/timer.rs
@@ -157,6 +157,7 @@ impl Timer {
 }
 
 #[cfg(test)]
+#[allow(clippy::float_cmp)]
 mod tests {
     use super::Timer;
 
diff --git a/crates/bevy_ecs/src/core/serde.rs b/crates/bevy_ecs/src/core/serde.rs
index 71bcc653a9..f7cc2e4ed2 100644
--- a/crates/bevy_ecs/src/core/serde.rs
+++ b/crates/bevy_ecs/src/core/serde.rs
@@ -17,7 +17,7 @@ impl<'de> Deserialize<'de> for Entity {
     where
         D: serde::Deserializer<'de>,
     {
-        Ok(deserializer.deserialize_u32(EntityVisitor)?)
+        deserializer.deserialize_u32(EntityVisitor)
     }
 }
 
diff --git a/crates/bevy_ecs/src/core/world.rs b/crates/bevy_ecs/src/core/world.rs
index b7adb54a97..44c64295dc 100644
--- a/crates/bevy_ecs/src/core/world.rs
+++ b/crates/bevy_ecs/src/core/world.rs
@@ -45,8 +45,7 @@ impl World {
     /// Create an empty world
     pub fn new() -> Self {
         // `flush` assumes archetype 0 always exists, representing entities with no components.
-        let mut archetypes = Vec::new();
-        archetypes.push(Archetype::new(Vec::new()));
+        let archetypes = vec![Archetype::new(Vec::new())];
         let mut index = HashMap::default();
         index.insert(Vec::new(), 0);
         Self {
diff --git a/crates/bevy_ecs/src/resource/resources.rs b/crates/bevy_ecs/src/resource/resources.rs
index a09d469740..f1c3b17233 100644
--- a/crates/bevy_ecs/src/resource/resources.rs
+++ b/crates/bevy_ecs/src/resource/resources.rs
@@ -1,4 +1,4 @@
-use crate::{system::SystemId, AtomicBorrow, TypeInfo};
+use crate::{system::SystemId, AtomicBorrow};
 use bevy_utils::HashMap;
 use core::any::TypeId;
 use downcast_rs::{impl_downcast, Downcast};
@@ -204,15 +204,14 @@ impl Resources {
 
     fn insert_resource<T: Resource>(&mut self, resource: T, resource_index: ResourceIndex) {
         let type_id = TypeId::of::<T>();
-        let data = self.resource_data.entry(type_id).or_insert_with(|| {
-            let mut types = Vec::new();
-            types.push(TypeInfo::of::<T>());
-            ResourceData {
+        let data = self
+            .resource_data
+            .entry(type_id)
+            .or_insert_with(|| ResourceData {
                 storage: Box::new(VecResourceStorage::<T>::default()),
                 default_index: None,
                 system_id_to_archetype_index: HashMap::default(),
-            }
-        });
+            });
 
         let storage = data
             .storage
@@ -500,6 +499,7 @@ mod tests {
     use crate::system::SystemId;
 
     #[test]
+    #[allow(clippy::float_cmp)]
     fn resource() {
         let mut resources = Resources::default();
         assert!(resources.get::<i32>().is_none());
diff --git a/crates/bevy_ecs/src/system/commands.rs b/crates/bevy_ecs/src/system/commands.rs
index 528c2d74eb..b2112c78c9 100644
--- a/crates/bevy_ecs/src/system/commands.rs
+++ b/crates/bevy_ecs/src/system/commands.rs
@@ -425,6 +425,7 @@ impl Commands {
 }
 
 #[cfg(test)]
+#[allow(clippy::float_cmp, clippy::approx_constant)]
 mod tests {
     use crate::{resource::Resources, Commands, World};
     use core::any::TypeId;
@@ -480,7 +481,7 @@ mod tests {
             .map(|(a, b)| (*a, *b))
             .collect::<Vec<_>>();
         assert_eq!(results_after, vec![]);
-        let results_after_u64 = world.query::<&u64>().map(|a| *a).collect::<Vec<_>>();
+        let results_after_u64 = world.query::<&u64>().copied().collect::<Vec<_>>();
         assert_eq!(results_after_u64, vec![]);
     }
 
diff --git a/crates/bevy_reflect/src/lib.rs b/crates/bevy_reflect/src/lib.rs
index 36974b3768..d5934c0e3f 100644
--- a/crates/bevy_reflect/src/lib.rs
+++ b/crates/bevy_reflect/src/lib.rs
@@ -56,6 +56,7 @@ pub use bevy_reflect_derive::*;
 pub use erased_serde;
 
 #[cfg(test)]
+#[allow(clippy::blacklisted_name, clippy::approx_constant)]
 mod tests {
     use ::serde::de::DeserializeSeed;
     use bevy_utils::HashMap;
@@ -67,6 +68,7 @@ mod tests {
     use crate::serde::{ReflectDeserializer, ReflectSerializer};
 
     use super::*;
+
     #[test]
     fn reflect_struct() {
         #[derive(Reflect)]
@@ -145,6 +147,7 @@ mod tests {
     }
 
     #[test]
+    #[allow(clippy::blacklisted_name)]
     fn reflect_unit_struct() {
         #[derive(Reflect)]
         struct Foo(u32, u64);
diff --git a/crates/bevy_reflect/src/path.rs b/crates/bevy_reflect/src/path.rs
index a8232f7c59..c19a7cc55c 100644
--- a/crates/bevy_reflect/src/path.rs
+++ b/crates/bevy_reflect/src/path.rs
@@ -305,6 +305,7 @@ fn next_token<'a>(path: &'a str, index: &mut usize) -> Option<Token<'a>> {
 }
 
 #[cfg(test)]
+#[allow(clippy::float_cmp, clippy::approx_constant)]
 mod tests {
     use super::GetPath;
     use crate::*;
diff --git a/crates/bevy_render/src/renderer/render_resource/render_resource_bindings.rs b/crates/bevy_render/src/renderer/render_resource/render_resource_bindings.rs
index da98c7ed5e..ecb0e8b2c2 100644
--- a/crates/bevy_render/src/renderer/render_resource/render_resource_bindings.rs
+++ b/crates/bevy_render/src/renderer/render_resource/render_resource_bindings.rs
@@ -330,12 +330,12 @@ mod tests {
         bindings.set("b", resource2.clone());
 
         let mut different_bindings = RenderResourceBindings::default();
-        different_bindings.set("a", resource3.clone());
-        different_bindings.set("b", resource4.clone());
+        different_bindings.set("a", resource3);
+        different_bindings.set("b", resource4);
 
         let mut equal_bindings = RenderResourceBindings::default();
         equal_bindings.set("a", resource1.clone());
-        equal_bindings.set("b", resource2.clone());
+        equal_bindings.set("b", resource2);
 
         let status = bindings.update_bind_group_status(&bind_group_descriptor);
         let id = if let BindGroupStatus::Changed(id) = status {
@@ -368,7 +368,7 @@ mod tests {
         };
 
         let mut unmatched_bindings = RenderResourceBindings::default();
-        unmatched_bindings.set("a", resource1.clone());
+        unmatched_bindings.set("a", resource1);
         let unmatched_bind_group_status =
             unmatched_bindings.update_bind_group_status(&bind_group_descriptor);
         assert_eq!(unmatched_bind_group_status, BindGroupStatus::NoMatch);
diff --git a/crates/bevy_render/src/shader/shader.rs b/crates/bevy_render/src/shader/shader.rs
index 1e5098fc63..7b6d686238 100644
--- a/crates/bevy_render/src/shader/shader.rs
+++ b/crates/bevy_render/src/shader/shader.rs
@@ -46,9 +46,9 @@ pub enum ShaderError {
     not(target_arch = "wasm32"),
     not(all(target_arch = "aarch64", target_os = "macos"))
 ))]
-impl Into<bevy_glsl_to_spirv::ShaderType> for ShaderStage {
-    fn into(self) -> bevy_glsl_to_spirv::ShaderType {
-        match self {
+impl From<ShaderStage> for bevy_glsl_to_spirv::ShaderType {
+    fn from(s: ShaderStage) -> bevy_glsl_to_spirv::ShaderType {
+        match s {
             ShaderStage::Vertex => bevy_glsl_to_spirv::ShaderType::Vertex,
             ShaderStage::Fragment => bevy_glsl_to_spirv::ShaderType::Fragment,
             ShaderStage::Compute => bevy_glsl_to_spirv::ShaderType::Compute,
diff --git a/crates/bevy_tasks/src/task_pool.rs b/crates/bevy_tasks/src/task_pool.rs
index 39e049eed2..db98543b17 100644
--- a/crates/bevy_tasks/src/task_pool.rs
+++ b/crates/bevy_tasks/src/task_pool.rs
@@ -269,6 +269,7 @@ impl<'scope, T: Send + 'scope> Scope<'scope, T> {
 }
 
 #[cfg(test)]
+#[allow(clippy::blacklisted_name)]
 mod tests {
     use super::*;
     use std::sync::{
diff --git a/tools/ci b/tools/ci
deleted file mode 100755
index aa970e108b..0000000000
--- a/tools/ci
+++ /dev/null
@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-
-# This script is intended to mimic some CI behavior that we encourage contributors to run locally.
-# For the actual CI run on GitHub, see the files in .github/workflows/
-
-# Exit when any command fails
-set -e
-
-# Keep track of the last executed command
-trap 'last_command=$current_command; current_command=$BASH_COMMAND' DEBUG
-# Echo an error message before exiting, so you can see exactly what command and what error code
-trap 'echo "\"${last_command}\" command filed with exit code $?."' EXIT
-
-## ACTUAL COMMANDS
-
-# Auto-format Rust files
-cargo +nightly fmt --all
-
-# Run a more intensive linter
-cargo clippy --all-targets --all-features -- -D warnings -A clippy::type_complexity -A clippy::manual-strip
\ No newline at end of file
diff --git a/tools/ci/Cargo.toml b/tools/ci/Cargo.toml
new file mode 100644
index 0000000000..cea60163c5
--- /dev/null
+++ b/tools/ci/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "ci"
+version = "0.1.0"
+authors = [
+    "Bevy Contributors <bevyengine@gmail.com>",
+    "Nathan Stocks <nathan@agileperception.com>"
+]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+xshell = "0.1"
diff --git a/tools/ci/src/main.rs b/tools/ci/src/main.rs
new file mode 100644
index 0000000000..952335133d
--- /dev/null
+++ b/tools/ci/src/main.rs
@@ -0,0 +1,19 @@
+use xshell::cmd;
+
+fn main() {
+    // When run locally, results may from actual CI runs triggered by .github/workflows/ci.yml
+    // - Official CI runs latest stable
+    // - Local runs use whatever the default Rust is locally
+
+    // See if any code needs to be formatted
+    cmd!("cargo fmt --all -- --check")
+        .run()
+        .expect("Please run 'cargo fmt --all' to format your code.");
+
+    // See if clippy has any complaints.
+    // - Type complexity must be ignored because we use huge templates for queries
+    // - `-A clippy::manual-strip` strip_prefix support was added in 1.45
+    cmd!("cargo clippy --workspace --all-targets --all-features -- -D warnings -A clippy::type_complexity -A clippy::manual-strip")
+    .run()
+    .expect("Please fix clippy errors in output above.");
+}