Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cargo test CI workflow #27

Merged
merged 4 commits into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
on:
pull_request:
branches:
- 'polkadot-v0.9.42'
- 'master'
ebma marked this conversation as resolved.
Show resolved Hide resolved

name: continuous-integration-test
jobs:
ci:
runs-on: ubuntu-20.04
env:
RUST_BACKTRACE: full
# Make sure CI fails on all warnings, including Clippy lints
RUSTFLAGS: "-Dwarnings"

steps:
- name: Freeing up more disk space
run: |
free -h
sudo rm -rf /usr/local/lib/android # will release about 10 GB if you don't need Android
sudo rm -rf /usr/share/dotnet # will release about 20GB if you don't need .NET
sudo rm -rf /opt/ghc
sudo rm -rf /usr/local/share/boost
sudo rm -rf /opt/hostedtoolcache/CodeQL
sudo rm -rf "$AGENT_TOOLSDIRECTORY"
sudo apt-get remove -y 'php.*' --fix-missing
sudo apt-get remove -y '^mongodb-.*' --fix-missing
sudo apt-get remove -y '^mysql-.*' --fix-missing
sudo apt-get clean
df -h
- uses: actions/checkout@v2

- name: Install package
run: |
sudo docker image prune --all --force
echo 'APT::Get::Always-Include-Phased-Updates "false";' | sudo tee /etc/apt/apt.conf.d/99-phased-updates
sudo apt-get update && sudo apt-get upgrade -y
sudo apt-get install -y protobuf-compiler libprotobuf-dev

- name: Setup Rust toolchain
# Call `rustup show` as a hack so that the toolchain defined in rust-toolchain.toml is installed
run: rustup show

- name: Use Cache
uses: Swatinem/rust-cache@v2
with:
cache-on-failure: true
key: "ubuntu-latest-cargo-${{ hashFiles('**/Cargo.lock') }}"
ebma marked this conversation as resolved.
Show resolved Hide resolved
shared-key: "shared"

- name: Install Protoc
uses: arduino/setup-protoc@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

- name: Build
uses: actions-rs/cargo@v1
with:
command: build
args: --all-features

- name: Test
uses: actions-rs/cargo@v1
with:
command: test
args: --all-features
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ extern crate alloc;

mod lib {
#[cfg(not(feature = "std"))]
pub use alloc::string::{String, ToString, FromUtf8Error};
pub use alloc::string::{FromUtf8Error, String, ToString};
#[cfg(feature = "std")]
pub use std::string::{String, ToString, FromUtf8Error};
pub use std::string::{FromUtf8Error, String, ToString};
}

mod amount;
Expand Down
6 changes: 4 additions & 2 deletions src/xdr/impls/claimable_balance_id.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
use crate::{AsBinary, ClaimableBalanceId, StellarSdkError, XdrCodec};
use crate::lib::{String, ToString};
use crate::{
lib::{String, ToString},
AsBinary, ClaimableBalanceId, StellarSdkError, XdrCodec,
};

pub trait IntoClaimbleBalanceId {
fn into_claimable_balance_id(self) -> Result<ClaimableBalanceId, StellarSdkError>;
Expand Down
2 changes: 1 addition & 1 deletion src/xdr/impls/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ impl<E: From<sp_std::str::Utf8Error>> crate::StellarTypeToString<Self, E> for Er
let msg = sp_std::str::from_utf8(msg).map_err(E::from)?;
Ok(format!("Error{{ code:{:?} message:{msg} }}", self.code))
}
}
}
2 changes: 1 addition & 1 deletion src/xdr/impls/generalized_transaction_set.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use crate::{
lib::{String, FromUtf8Error},
compound_types::UnlimitedVarArray,
lib::{FromUtf8Error, String},
types::{GeneralizedTransactionSet, TransactionPhase, TxSetComponent},
Hash, IntoHash, StellarSdkError, TransactionEnvelope, XdrCodec,
};
Expand Down
7 changes: 4 additions & 3 deletions src/xdr/xdr_codec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -210,16 +210,17 @@ impl<T: XdrCodec> XdrCodec for Box<T> {
///
/// Basic usage:
///
/// ```
/// use crate::types::Auth;
#[cfg_attr(feature = "all-types", doc = "```")]
#[cfg_attr(not(feature = "all-types"), doc = "```ignore")]
/// use substrate_stellar_sdk::{types::Auth, parse_stellar_type};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a comment here on why this is necessary? Maybe we can add the explanation as a a simple comment // here instead of a doc comment without breaking the rest?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you check the generated docs whether the lines

/// // For this test, we require the usage of `Auth` which is only compiled with
/// // the `all-types` feature.
/// // We will ignore the test if the feature is not enabled.

are ignored? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh okay I misunderstood what you meant, I thought ignored on compilation. Latest push should show it like this (they just need to be in the scope of the test definition)
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks 🙏

/// let auth_xdr = [0, 0, 0, 1];
/// let result = parse_stellar_type!(auth_xdr,Auth);
/// assert_eq!(result, Ok(Auth { flags: 1 }))
/// ```
#[macro_export]
macro_rules! parse_stellar_type {
($ref:ident, $struct_str:ident) => {{
use $crate::{types::$struct_str, StellarSdkError};
use $crate::{types::$struct_str, StellarSdkError, XdrCodec};

let ret: Result<$struct_str, StellarSdkError> =
$struct_str::from_xdr($ref).map_err(|_| StellarSdkError::DecodeError(stringify!($struct_str).into()));
Expand Down
Loading