stateless-journey.sh

#!/usr/bin/env bash
set -eu

exe=${1:?First argument must be the executable to test}

root="$(cd "${0%/*}" && pwd)"
exe="$(cd "${exe%/*}" && echo "$(pwd)/${exe##*/}")"
# shellcheck disable=1090
source "$root/utilities.sh"
source "$root/helpers.sh"
snapshot="$root/snapshots"

SUCCESSFULLY=0
WITH_FAILURE=1

function remove_paths() {
    sed 's_`/.*`_<redacted>_g'
}

# This filter is required as bytecounts fluctuate due to changing meta-data/timestamps
function remove_bytecounts() {
    sed -E 's/[0-9]+ B/<bytecount>/g'
}


(in-clone-of https://github.com/greshake/i3status-rust
  stepn "reproduce https://github.com/the-lean-crate/cargo-diet/issues/1"
  (when "cargo diet in dry-run mode"
    it "runs successfully" && {
      expect_run ${SUCCESSFULLY} "$exe" diet -n
    }
  )
)

(sandbox
  (with "with no cargo project"
    it "fails with an error message" && {
      SNAPSHOT_FILTER=remove_paths \
      WITH_SNAPSHOT="$snapshot/failure-no-cargo-manifest" \
      expect_run ${WITH_FAILURE} "$exe" diet
    }
  )
  (with "with an invalid cargo project"
    echo "foobar" > Cargo.toml
    it "fails with a human readable error message" && {
      SNAPSHOT_FILTER=remove_paths \
      WITH_SNAPSHOT="$snapshot/failure-invalid-cargo-manifest" \
      expect_run ${WITH_FAILURE} "$exe" diet
    }
  )
  (with "with a cargo project that causes package failure"
    cp "$root/fixtures/artichoke-cargo.toml" Cargo.toml
    it "fails with a human readable error message" && {
      SNAPSHOT_FILTER=remove_paths \
      WITH_SNAPSHOT="$snapshot/failure-invalid-cargo-manifest-due-to-packaging-with-human-readable-error" \
      expect_run ${WITH_FAILURE} "$exe" diet
    }
  )
  (when "asking for help"
    it "succeeds" && {
      expect_run ${SUCCESSFULLY} "$exe" diet --help
    }
  )
)

(with "a cargo user and email"
  export CARGO_NAME=author
  export CARGO_EMAIL=author@example.com

  (sandbox
    (with "a newly initialized cargo project with one dependency that doesnt exist"
      step "init cargo project" &&
        expect_run ${SUCCESSFULLY} cargo init --name library --bin
        echo 'should-never-exist-on-cratesio = "42.21.10"' >> Cargo.toml

      it "succeeds" && {
        SNAPSHOT_FILTER=remove_paths \
        WITH_SNAPSHOT="$snapshot/success-invalid-dependencies-but-valid-package" \
        expect_run ${SUCCESSFULLY} "$exe" diet
      }

      (when "running it with --save-package-for-unit-test flag"
        FILE_PATH=name-of-package-for-testing.rmp
        it "succeeds" && {
          WITH_SNAPSHOT="$snapshot/success-save-package" \
          expect_run ${SUCCESSFULLY} "$exe" diet --save-package-for-unit-test "${FILE_PATH}"
        }

        it "creates the file at the given path" && {
         expect_exists "${FILE_PATH}"
        }
      )
    )
  )

  (sandbox
    (with "a newly initialized cargo project"
      step "init cargo project" &&
        expect_run ${SUCCESSFULLY} cargo init --name library --bin

      (with "the --dry-run flag set"
        it "runs successfully and states the crate is lean" && {
          WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-dry-run" \
          expect_run ${SUCCESSFULLY} "$exe" diet --dry-run
        }

        it "does not modify the Cargo.toml file" && {
          expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml" "Cargo.toml"
        }
      )

      (with "NO --dry-run flag set"
        it "runs successfully and states the crate is lean" && {
          WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project" \
          expect_run ${SUCCESSFULLY} "$exe" diet
        }

        it "does not modify the Cargo.toml file" && {
          expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml" "Cargo.toml"
        }
      )

      (when "running it again"
        it "runs successfully" && {
          WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project" \
          expect_run ${SUCCESSFULLY} "$exe" diet
        }

        it "produces exactly the same output as before" && {
          expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml" "Cargo.toml"
        }
      )

      (with "a new test file which is part of the src/ directory"
        touch src/lib_test.rs

        (with "the -n (dry-run) flag set"
          it "runs successfully and prints diff information" && {
            WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-test-added-dry-run" \
            expect_run ${SUCCESSFULLY} "$exe" diet -n
          }

          it "does not alter Cargo.toml" && {
            expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml-with-tests-excluded-dry-run" "Cargo.toml"
          }
        )

        (with "NO --dry-run flag set"
          (when "running it again"
            it "runs successfully and states the changes" && {
              WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-test-added" \
              expect_run ${SUCCESSFULLY} "$exe" diet
            }

            it "produces a new include directive which explicitly excludes the new file type" && {
              expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml-with-tests-excluded" "Cargo.toml"
            }
          )
        )
      )
      (with "a new README file in the project root"
        touch README.md

        (when "running it"
          it "runs successfully" && {
            WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project" \
            expect_run ${SUCCESSFULLY} "$exe" diet
          }

          it "produces the same include as before, effectively not picking up a file it should pick up!" && {
            expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml-with-tests-excluded" "Cargo.toml"
          }
        )

        (with "the --reset-manifest flag set"
          (with "the --dry-run flag set"
            it "runs successfully" && {
              WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-test-added-reset-dry-run" \
              expect_run ${SUCCESSFULLY} "$exe" diet --reset-manifest --dry-run
            }

            it "does not alter the Cargo.toml file" && {
              expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml-with-tests-excluded" "Cargo.toml"
            }
          )

          (with "NO --dry-run flag set"
            it "runs successfully" && {
              WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-test-added-no-dryrun" \
              expect_run ${SUCCESSFULLY} "$exe" diet -r
            }

            it "produces a new include that includes the new file." && {
              expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml-with-tests-excluded-and-readme" "Cargo.toml"
            }
          )
        )

        (with "NO --reset-manifest flag"
          it "runs successfully" && {
            WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project" \
            expect_run ${SUCCESSFULLY} "$exe" diet
          }

          it "does not alter the cargo manifest" && {
            expect_snapshot "$snapshot/success-include-directive-in-new-project-cargo-toml-with-tests-excluded-and-readme" "Cargo.toml"
          }
        )

        (with "the --package-size-limit flag"
          (when "the limit is lower than the actual package size"
            it "runs successfully" && {
              SNAPSHOT_FILTER=remove_bytecounts \
              WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-limit-exceeded" \
              expect_run ${WITH_FAILURE} "$exe" diet --package-size-limit 50B
            }

            it "does not put a file in target/package" && {
              expect_run ${WITH_FAILURE} find target/package
            }
          )
          (when "the limit is higher than the actual package size"
            it "runs successfully" && {
              SNAPSHOT_FILTER=remove_bytecounts \
              WITH_SNAPSHOT="$snapshot/success-include-directive-in-new-project-limit-not-exceeded" \
              expect_run ${SUCCESSFULLY} "$exe" diet --package-size-limit 50KB
            }

            it "does not put a file in target/package" && {
              expect_run ${WITH_FAILURE} find target/package
            }
          )
        )
      )
    )
  )
)