From e13aa4c2a04d04ab10fd77ce371a1f37b002de36 Mon Sep 17 00:00:00 2001
From: huntc <huntchr@gmail.com>
Date: Tue, 6 Jul 2021 12:23:51 +1000
Subject: [PATCH] Add tests to our CI

Also found some doctests that were failing
---
 .github/workflows/rust.yml      | 10 ++++++++++
 embassy/src/executor/timer.rs   |  3 ---
 embassy/src/io/util/copy_buf.rs |  2 +-
 embassy/src/util/signal.rs      |  1 -
 4 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
index fc836dfc..b2b7ee09 100644
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/rust.yml
@@ -122,6 +122,16 @@ jobs:
       - name: Check fmt
         run: for i in embassy-*; do (cd $i; cargo fmt -- --check); done
 
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - name: Test
+        run: cd embassy && cargo test
+
   metapac_gen:
     runs-on: ubuntu-latest
     steps:
diff --git a/embassy/src/executor/timer.rs b/embassy/src/executor/timer.rs
index d66c7cae..8ee33696 100644
--- a/embassy/src/executor/timer.rs
+++ b/embassy/src/executor/timer.rs
@@ -67,7 +67,6 @@ impl Timer {
     /// # #![feature(type_alias_impl_trait)]
     /// #
     /// # fn foo() {}
-    /// use embassy::executor::task;
     /// use embassy::time::{Duration, Timer};
     ///
     /// #[embassy::task]
@@ -110,7 +109,6 @@ impl Future for Timer {
 /// # #![feature(impl_trait_in_bindings)]
 /// # #![feature(type_alias_impl_trait)]
 /// #
-/// use embassy::executor::task;
 /// use embassy::time::{Duration, Timer};
 /// # fn foo() {}
 ///
@@ -134,7 +132,6 @@ impl Future for Timer {
 /// # #![feature(impl_trait_in_bindings)]
 /// # #![feature(type_alias_impl_trait)]
 /// #
-/// use embassy::executor::task;
 /// use embassy::time::{Duration, Ticker};
 /// use futures::StreamExt;
 /// # fn foo(){}
diff --git a/embassy/src/io/util/copy_buf.rs b/embassy/src/io/util/copy_buf.rs
index c7e324d9..6d7932a0 100644
--- a/embassy/src/io/util/copy_buf.rs
+++ b/embassy/src/io/util/copy_buf.rs
@@ -17,7 +17,7 @@ use crate::io::{AsyncBufRead, AsyncWrite, Error, Result};
 ///
 /// # Examples
 ///
-/// ```
+/// ``` ignore
 /// # futures::executor::block_on(async {
 /// use futures::io::{self, AsyncWriteExt, Cursor};
 ///
diff --git a/embassy/src/util/signal.rs b/embassy/src/util/signal.rs
index af261c45..bb832533 100644
--- a/embassy/src/util/signal.rs
+++ b/embassy/src/util/signal.rs
@@ -119,7 +119,6 @@ unsafe impl cortex_m::interrupt::Nr for NrWrap {
 /// ``` no_compile
 /// use embassy::traits::*;
 /// use embassy::util::InterruptFuture;
-/// use embassy::executor::task;
 /// use embassy_stm32::interrupt; // Adjust this to your MCU's embassy HAL.
 /// #[embassy::task]
 /// async fn demo_interrupt_future() {