Merge #9: Add codecov ci workflow

0b85f92 Add badges in README (Steve Myers)
d8083c7 Add codecov ci workflow (Steve Myers)

Pull request description:

  Added code coverage and new badges in README.

Top commit has no ACKs.

Tree-SHA512: 45a731dc007db69807714441a62d1d3543399c51df4d71756d114ae25713b22d84d90294c9ef520f86b5eb825f2def1915c759056389d3c844b2b6c9825e2bc3

Author: notmandatory

.github/workflows/code_coverage.yml

@@ -0,0 +1,61 @@
+on: [push, pull_request]
+
+name: Code Coverage
+
+jobs:
+  Codecov:
+    name: Code Coverage
+    runs-on: ubuntu-latest
+    env:
+      RUSTFLAGS: "-Cinstrument-coverage"
+      RUSTDOCFLAGS: "-Cinstrument-coverage"
+      LLVM_PROFILE_FILE: "report-%p-%m.profraw"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install lcov tools
+        run: sudo apt-get install lcov -y
+      - name: Install rustup
+        run: curl https://sh.rustup.rs -sSf | sh -s -- -y
+      - name: Set default toolchain
+        run: rustup default nightly
+      - name: Set profile
+        run: rustup set profile minimal
+      - name: Add llvm tools
+        run: rustup component add llvm-tools-preview
+      - name: Update toolchain
+        run: rustup update
+      - name: Cache cargo
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Install grcov
+        run: if [[ ! -e ~/.cargo/bin/grcov ]]; then cargo install grcov; fi
+      - name: Test
+        # WARNING: this is not testing the following features: test-esplora, test-hardware-signer, async-interface
+        # This is because some of our features are mutually exclusive, and generating various reports and
+        # merging them doesn't seem to be working very well.
+        # For more info, see:
+        # - https://github.com/bitcoindevkit/bdk/issues/696
+        # - https://github.com/bitcoindevkit/bdk/pull/748#issuecomment-1242721040
+        run: cargo test
+      - name: Run grcov
+        run: mkdir coverage; grcov . --binary-path ./target/debug/ -s . -t lcov --branch --ignore-not-existing --ignore '/*' -o ./coverage/lcov.info
+      - name: Generate HTML coverage report
+        run: genhtml -o coverage-report.html ./coverage/lcov.info
+
+      - name: Coveralls upload
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-report
+          path: coverage-report.html

README.md

@@ -1,3 +1,13 @@
 # rust-esplora-client
 
-Bitcoin Esplora API client library. Supports plaintext, TLS and Onion servers. Blocking or async
+Bitcoin Esplora API client library. Supports plaintext, TLS and Onion servers. Blocking or async.
+
+<p>
+    <a href="https://crates.io/crates/rust-esplora-client"><img alt="Crate Info" src="https://img.shields.io/crates/v/rust-esplora-client.svg"/></a>
+    <a href="https://github.com/bitcoindevkit/rust-esplora-client/blob/master/LICENSE"><img alt="MIT Licensed" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+    <a href="https://github.com/bitcoindevkit/rust-esplora-client/actions?query=workflow%3ACode%20Coverage"><img alt="CI Status" src="https://github.com/bitcoindevkit/rust-esplora-client/workflows/Code%20Coverage/badge.svg"></a>
+    <a href='https://coveralls.io/github/bitcoindevkit/rust-esplora-client?branch=master'><img src='https://coveralls.io/repos/github/bitcoindevkit/rust-esplora-client/badge.svg?branch=master' alt='Coverage Status' /></a>
+    <a href="https://docs.rs/rust-esplora-client"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-rust-esplora-client-green"/></a>
+    <a href="https://blog.rust-lang.org/2021/11/01/Rust-1.56.1.html"><img alt="Rustc Version 1.56.1+" src="https://img.shields.io/badge/rustc-1.56.1%2B-lightgrey.svg"/></a>
+    <a href="https://discord.gg/d7NkDKm"><img alt="Chat on Discord" src="https://img.shields.io/discord/753336465005608961?logo=discord"></a>
+</p>