diff --git a/.github/workflows/audit.yml b/.github/workflows/audit.yml index d0a91a1..63cf181 100644 --- a/.github/workflows/audit.yml +++ b/.github/workflows/audit.yml @@ -9,7 +9,7 @@ on: workflow_dispatch: jobs: - security_audit: + security_audit: # TODO remove this version ? runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 @@ -21,3 +21,10 @@ jobs: steps: - uses: actions/checkout@v3 - uses: EmbarkStudios/cargo-deny-action@v1 + cargo-audit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions-rs/audit-check@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/build_test.yml b/.github/workflows/build_test.yml new file mode 100644 index 0000000..35b0783 --- /dev/null +++ b/.github/workflows/build_test.yml @@ -0,0 +1,26 @@ +name: Build and Test +on: + push: + workflow_dispatch: + +jobs: + fmt: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: dtolnay/rust-toolchain@stable + with: + components: clippy, rustfmt + - name: Formatting + run: cargo fmt --check + - name: Linting + run: cargo clippy -- -D warnings + - name: Build dev + run: cargo build + - name: Test dev + run: cargo test + - name: Build release + run: cargo build + - name: Test release + run: cargo test + diff --git a/Cargo.toml b/Cargo.toml index 01ded1c..7fa2002 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "millennium_falcon" version = "0.1.0" +license = "MIT" edition = "2021" default-run = "millennium_falcon" diff --git a/Readme.md b/Readme.md index 9aedda6..609f390 100644 --- a/Readme.md +++ b/Readme.md @@ -6,7 +6,7 @@ Solution of the [developer-test](https://github.com/lioncowlionant/developer-tes The code follows the onion architecture. More specifically, the code is divided into 4 sections: -- Domain modeld +- Domain model - Domain services - Application services - Infrastructure services @@ -29,37 +29,33 @@ Contains code to connect and read from the DB, process the CLI input and definin ## Technology stack -This code was written in Rust 1.75.0. - -For linter, formatter, test, code coverage and code security audit, please refer to the CI in `.github/workflow` - -given the number of star in the galaxy, the code may handle a large amont of data => Rust - -test: - -- full black-box tests for the endpoints -- some scenario tests for the example provided in the documentation -- unit-test inside the code - -or the backend of the technical test. - -Instrumented -observability -database migrations -automated tests -benchmark - -coverage - -Questions: - -Hello ! -Thanks a lot. I've had a look at the test and I have a couple of question regarding the technical requirements: - -- Is it possible to have an upper-bound for the number of planets, the number of bounty hunters, the number of routes and the countdown ? -- Should I consider that the database containing the ROUTES table can be load in memory, or should I consider that in the real application this database is too big, and I should only query it (as if it wasn't sqlite)? -- Is it possible to have some details on the hardware of the Millennium Falcon ? Is it running x86-64 or ARM ? Is it running Linux, MacOS or Windows ? Is there a maximum limit of CPU/RAM/Time that I should be aware of? -- How many simultaneous connections are expected to the server ? -- Are you expecting 2 different servers for serving the front and the back ? Or could the backend be responsible serving the frontend ? - -- How strong are the DB assumptions ? When executing a `.schema ROUTES` on the DB file, it gave: `CREATE TABLE routes ( origin TEXT, destination TEXT, travel_time UNSIGNED INTEGER);`, so nothing prevent the origin and destination to be null or empty. +- This code was written in Rust 1.75.0. + +### CI + +- A github action perform a security audit every day. More specifically: + - cargo-deny check for security vulnerabilities, license violation, unmaintained projects and several other things + - cargo-audit for a second security audit. Seems to find more stuff than cargo-deny +- A second CI run the classic steps: + + - format with `cargo-fmt` + - lint with `clippy` + - build and test in dev mode + - build and test again in release mode + - build the docker image + - push the docker image to dockerhub + +## TODO + +- coverage is missing +- bulding the docker image +- pushing to dockerhub with a dev tag +- release-please +- release protocol +- front +- Instrumented +- observability +- test: + - full black-box tests for the endpoints + - some scenario tests for the example provided in the documentation + - unit-test inside the code diff --git a/deny.toml b/deny.toml new file mode 100644 index 0000000..e9c9a3f --- /dev/null +++ b/deny.toml @@ -0,0 +1,273 @@ +# This template contains all of the possible sections and their default values + +# Note that all fields that take a lint level have these possible values: +# * deny - An error will be produced and the check will fail +# * warn - A warning will be produced, but the check will not fail +# * allow - No warning or error will be produced, though in some cases a note +# will be + +# The values provided in this template are the default values that will be used +# when any section or field is not specified in your own configuration + +# Root options + +# If 1 or more target triples (and optionally, target_features) are specified, +# only the specified targets will be checked when running `cargo deny check`. +# This means, if a particular package is only ever used as a target specific +# dependency, such as, for example, the `nix` crate only being used via the +# `target_family = "unix"` configuration, that only having windows targets in +# this list would mean the nix crate, as well as any of its exclusive +# dependencies not shared by any other crates, would be ignored, as the target +# list here is effectively saying which targets you are building for. +targets = [ + # The triple can be any string, but only the target triples built in to + # rustc (as of 1.40) can be checked against actual config expressions + #{ triple = "x86_64-unknown-linux-musl" }, + # You can also specify which target_features you promise are enabled for a + # particular target. target_features are currently not validated against + # the actual valid features supported by the target architecture. + #{ triple = "wasm32-unknown-unknown", features = ["atomics"] }, +] +# When creating the dependency graph used as the source of truth when checks are +# executed, this field can be used to prune crates from the graph, removing them +# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate +# is pruned from the graph, all of its dependencies will also be pruned unless +# they are connected to another crate in the graph that hasn't been pruned, +# so it should be used with care. The identifiers are [Package ID Specifications] +# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html) +#exclude = [] +# If true, metadata will be collected with `--all-features`. Note that this can't +# be toggled off if true, if you want to conditionally enable `--all-features` it +# is recommended to pass `--all-features` on the cmd line instead +all-features = false +# If true, metadata will be collected with `--no-default-features`. The same +# caveat with `all-features` applies +no-default-features = false +# If set, these feature will be enabled when collecting metadata. If `--features` +# is specified on the cmd line they will take precedence over this option. +#features = [] +# When outputting inclusion graphs in diagnostics that include features, this +# option can be used to specify the depth at which feature edges will be added. +# This option is included since the graphs can be quite large and the addition +# of features from the crate(s) to all of the graph roots can be far too verbose. +# This option can be overridden via `--feature-depth` on the cmd line +feature-depth = 1 + +# This section is considered when running `cargo deny check advisories` +# More documentation for the advisories section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html +[advisories] +# The path where the advisory database is cloned/fetched into +db-path = "~/.cargo/advisory-db" +# The url(s) of the advisory databases to use +db-urls = ["https://github.com/rustsec/advisory-db"] +# The lint level for security vulnerabilities +vulnerability = "deny" +# The lint level for unmaintained crates +unmaintained = "warn" +# The lint level for crates that have been yanked from their source registry +yanked = "warn" +# The lint level for crates with security notices. Note that as of +# 2019-12-17 there are no security notice advisories in +# https://github.com/rustsec/advisory-db +notice = "warn" +# A list of advisory IDs to ignore. Note that ignored advisories will still +# output a note when they are encountered. +ignore = [ + #"RUSTSEC-0000-0000", +] +# Threshold for security vulnerabilities, any vulnerability with a CVSS score +# lower than the range specified will be ignored. Note that ignored advisories +# will still output a note when they are encountered. +# * None - CVSS Score 0.0 +# * Low - CVSS Score 0.1 - 3.9 +# * Medium - CVSS Score 4.0 - 6.9 +# * High - CVSS Score 7.0 - 8.9 +# * Critical - CVSS Score 9.0 - 10.0 +#severity-threshold = + +# If this is true, then cargo deny will use the git executable to fetch advisory database. +# If this is false, then it uses a built-in git library. +# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. +# See Git Authentication for more information about setting up git authentication. +#git-fetch-with-cli = true + +# This section is considered when running `cargo deny check licenses` +# More documentation for the licenses section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html +[licenses] +# The lint level for crates which do not have a detectable license +unlicensed = "deny" +# List of explicitly allowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +allow = [ + "MIT", + "Apache-2.0", + "Unicode-DFS-2016", + "BSD-3-Clause" + #"Apache-2.0 WITH LLVM-exception", +] +# List of explicitly disallowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. +deny = [ + #"Nokia", +] +# Lint level for licenses considered copyleft +copyleft = "warn" +# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses +# * both - The license will be approved if it is both OSI-approved *AND* FSF +# * either - The license will be approved if it is either OSI-approved *OR* FSF +# * osi - The license will be approved if it is OSI approved +# * fsf - The license will be approved if it is FSF Free +# * osi-only - The license will be approved if it is OSI-approved *AND NOT* FSF +# * fsf-only - The license will be approved if it is FSF *AND NOT* OSI-approved +# * neither - This predicate is ignored and the default lint level is used +allow-osi-fsf-free = "neither" +# Lint level used when no other predicates are matched +# 1. License isn't in the allow or deny lists +# 2. License isn't copyleft +# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither" +default = "deny" +# The confidence threshold for detecting a license from license text. +# The higher the value, the more closely the license text must be to the +# canonical license text of a valid SPDX license file. +# [possible values: any between 0.0 and 1.0]. +confidence-threshold = 0.8 +# Allow 1 or more licenses on a per-crate basis, so that particular licenses +# aren't accepted for every possible crate as with the normal allow list +exceptions = [ + # Each entry is the crate and version constraint, and its specific allow + # list + #{ allow = ["Zlib"], name = "adler32", version = "*" }, +] + +# Some crates don't have (easily) machine readable licensing information, +# adding a clarification entry for it allows you to manually specify the +# licensing information +#[[licenses.clarify]] +# The name of the crate the clarification applies to +#name = "ring" +# The optional version constraint for the crate +#version = "*" +# The SPDX expression for the license requirements of the crate +#expression = "MIT AND ISC AND OpenSSL" +# One or more files in the crate's source used as the "source of truth" for +# the license expression. If the contents match, the clarification will be used +# when running the license check, otherwise the clarification will be ignored +# and the crate will be checked normally, which may produce warnings or errors +# depending on the rest of your configuration +#license-files = [ + # Each entry is a crate relative path, and the (opaque) hash of its contents + #{ path = "LICENSE", hash = 0xbd0eed23 } +#] + +[licenses.private] +# If true, ignores workspace crates that aren't published, or are only +# published to private registries. +# To see how to mark a crate as unpublished (to the official registry), +# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field. +ignore = false +# One or more private registries that you might publish crates to, if a crate +# is only published to private registries, and ignore is true, the crate will +# not have its license(s) checked +registries = [ + #"https://sekretz.com/registry +] + +# This section is considered when running `cargo deny check bans`. +# More documentation about the 'bans' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html +[bans] +# Lint level for when multiple versions of the same crate are detected +multiple-versions = "warn" +# Lint level for when a crate version requirement is `*` +wildcards = "allow" +# The graph highlighting used when creating dotgraphs for crates +# with multiple versions +# * lowest-version - The path to the lowest versioned duplicate is highlighted +# * simplest-path - The path to the version with the fewest edges is highlighted +# * all - Both lowest-version and simplest-path are used +highlight = "all" +# The default lint level for `default` features for crates that are members of +# the workspace that is being checked. This can be overridden by allowing/denying +# `default` on a crate-by-crate basis if desired. +workspace-default-features = "allow" +# The default lint level for `default` features for external crates that are not +# members of the workspace. This can be overridden by allowing/denying `default` +# on a crate-by-crate basis if desired. +external-default-features = "allow" +# List of crates that are allowed. Use with care! +allow = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# List of crates to deny +deny = [ + # Each entry the name of a crate and a version range. If version is + # not specified, all versions will be matched. + #{ name = "ansi_term", version = "=0.11.0" }, + # + # Wrapper crates can optionally be specified to allow the crate when it + # is a direct dependency of the otherwise banned crate + #{ name = "ansi_term", version = "=0.11.0", wrappers = [] }, +] + +# List of features to allow/deny +# Each entry the name of a crate and a version range. If version is +# not specified, all versions will be matched. +#[[bans.features]] +#name = "reqwest" +# Features to not allow +#deny = ["json"] +# Features to allow +#allow = [ +# "rustls", +# "__rustls", +# "__tls", +# "hyper-rustls", +# "rustls", +# "rustls-pemfile", +# "rustls-tls-webpki-roots", +# "tokio-rustls", +# "webpki-roots", +#] +# If true, the allowed features must exactly match the enabled feature set. If +# this is set there is no point setting `deny` +#exact = true + +# Certain crates/versions that will be skipped when doing duplicate detection. +skip = [ + #{ name = "ansi_term", version = "=0.11.0" }, +] +# Similarly to `skip` allows you to skip certain crates during duplicate +# detection. Unlike skip, it also includes the entire tree of transitive +# dependencies starting at the specified crate, up to a certain depth, which is +# by default infinite. +skip-tree = [ + #{ name = "ansi_term", version = "=0.11.0", depth = 20 }, +] + +# This section is considered when running `cargo deny check sources`. +# More documentation about the 'sources' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html +[sources] +# Lint level for what to happen when a crate from a crate registry that is not +# in the allow list is encountered +unknown-registry = "warn" +# Lint level for what to happen when a crate from a git repository that is not +# in the allow list is encountered +unknown-git = "warn" +# List of URLs for allowed crate registries. Defaults to the crates.io index +# if not specified. If it is specified but empty, no registries are allowed. +allow-registry = ["https://github.com/rust-lang/crates.io-index"] +# List of URLs for allowed Git repositories +allow-git = [] + +[sources.allow-org] +# 1 or more github.com organizations to allow git sources for +github = [""] +# 1 or more gitlab.com organizations to allow git sources for +gitlab = [""] +# 1 or more bitbucket.org organizations to allow git sources for +bitbucket = [""] diff --git a/src/application_services.rs b/src/application_services.rs index 1a01b51..d6bbbe7 100644 --- a/src/application_services.rs +++ b/src/application_services.rs @@ -93,7 +93,6 @@ pub fn into_galaxy_routes_and_planet_id(routes: Vec) -> (GalaxyRoutes, Pl #[cfg(test)] mod test { - use crate::{ application_services::BountyHunter, diff --git a/src/domain_model.rs b/src/domain_model.rs index 34ecab9..30e80a3 100644 --- a/src/domain_model.rs +++ b/src/domain_model.rs @@ -1,7 +1,6 @@ use std::collections::{HashMap, HashSet}; use std::fmt::Display; - use anyhow::anyhow; use anyhow::Result; diff --git a/src/domain_services.rs b/src/domain_services.rs index f324304..4eaa741 100644 --- a/src/domain_services.rs +++ b/src/domain_services.rs @@ -1,6 +1,6 @@ use std::{cmp::Reverse, collections::BinaryHeap}; -use anyhow::{Result}; +use anyhow::Result; use crate::domain_model::{BountyHunterPlanning, GalaxyRoutes, PlanetCatalog, PlanetId}; @@ -94,7 +94,6 @@ fn probability_been_captured(n_bounty_hunter: u64) -> f64 { #[cfg(test)] mod test { - use crate::{ domain_model::{BountyHunterPlanning, GalaxyRoutes, PlanetCatalog}, diff --git a/src/infrastructure_service.rs b/src/infrastructure_service.rs index 9c84918..4dd3910 100644 --- a/src/infrastructure_service.rs +++ b/src/infrastructure_service.rs @@ -1,4 +1,4 @@ -use actix_web::{dev::Server, get, web, App, HttpResponse, HttpServer, Responder}; +use actix_web::{dev::Server, get, App, HttpResponse, HttpServer, Responder}; use anyhow::anyhow; use anyhow::Context; use anyhow::Result;