https://github.com/oknozor/citerne

Test container layer for diesel orm
https://github.com/oknozor/citerne

Last synced: about 1 month ago
JSON representation

Test container layer for diesel orm

• Host: GitHub
• URL: https://github.com/oknozor/citerne
• Owner: oknozor
• License: mit
• Created: 2022-09-22T10:17:31.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-22T22:34:43.000Z (about 2 years ago)
• Last Synced: 2024-09-15T10:52:34.862Z (about 2 months ago)
• Language: Rust
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Citerne 🚚

[Latest Version]: https://img.shields.io/crates/v/citerne.svg

[crates.io]: https://www.crates.io/crates/citerne

[![Latest Version]][crates.io] ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/oknozor/citerne) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) ![License](https://img.shields.io/github/license/oknozor/citerne)

Citerne is a wrapper around [diesel](https://crates.io/crates/diesel) and [testcontainers](https://crates.io/crates/testcontainers)

providing a single proc macro to run tests on a containerized database.

---

## Roadmap

- [ ] mysql support 

- [ ] reexpose needed diesel features (chrono, time etc)

## Usage

```toml

# Cargo.toml

citerne = {version = "0.1", features = ["postgres"] }

```

**Embedding diesel migrations:**

You must provide a diesel migration directory (relative to your crate root directory).

Citerne will set up a database container and execute all migration in the directory.

```rust

#[derive(Insertable)]

#[diesel(table_name = dummy)]

struct NewDummy { value: String }

    #[database_container_test(migrations = ["./migrations"])]

    fn simple_migrations(conn: &mut PgConnection) -> CiterneResult<()> {

        let value = NewDummy { value: "one".to_string() };

        let sql_result = diesel::insert_into(dummy::table)

            .values(value)

            .execute(conn)?;

        assert_eq!(sql_result, 1);

        Ok(())

    }

```

**Custom migration files:**

You can directly embed a single sql migration file to populate your containerized database

with fixture data.

Note that the `migrations` execution is ordered, you always need to provide diesel migrations first.  

```rust

    #[database_container_test(migrations = ["./migrations", "./tests/dummy.sql"])]

    fn migration_with_data_script(conn: &mut PgConnection) -> CiterneResult<()> {

        use crate::schema::dummy::value;

        use crate::test::dummy::dsl::dummy;

        let dummies: Vec = dummy.select(value).load::(conn)?;

        assert_eq!(dummies, vec!["yeah".to_string(), "yo".to_string()]);

        Ok(())

    }

```

**Raw sql script:**

Alternatively if you need your fixture data to appear in the test

you can use the `sql` attribute. Note that you can combine both approach.

```rust

    #[database_container_test(

        migrations = ["./migrations"]

        sql = r#"

           INSERT INTO dummy (value) VALUES ('yeah');

           INSERT INTO dummy (value) VALUES ('yo');

        "#

    )]

    fn migration_with_raw_sql_script(conn: &mut PgConnection) -> CiterneResult<()> {

        use crate::schema::dummy::value;

        use crate::test::dummy::dsl::dummy;

        let dummies: Vec = dummy.select(value).load::(conn)?;

        assert_eq!(dummies, vec!["yeah".to_string(), "yo".to_string()]);

        Ok(())

    }

```

## License

All the code in this repository is released under the MIT License, for more information take a look at the [LICENSE](LICENSE) file.