S3 Sync
Find a file
Paul Campbell 8cca46340c
Replace cats-effect with zio (#117)
* [sbt] Add ZIO dependency to storage-api

* Convert to use ZIO

* [sbt] remove cats-effect dependency

* [changelog] updated

* [cli] Program restore actions to correct order (copy, upload, delete)

* [cli] Program You should not name methods after their defining object

* [core] ConfigValidationException Redundant braces after class definition

* [core] LocalFileStreamSuite Usage of get on optional type.

* [core] PlanBuilderTest Usage of get on optional type.
2019-07-21 21:02:04 +01:00
.github [github] Add stale configuration 2019-05-14 07:05:48 +01:00
bin Rename project to Thorp (#75) 2019-06-17 15:33:49 +01:00
cli/src Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
core/src Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
domain/src Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
project Update sbt-assembly to 0.14.10 (#105) 2019-07-06 13:47:24 +01:00
storage-api/src/main/scala/net/kemitix/thorp/storage/api Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
storage-aws/src Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
.gitignore Rename project to Thorp (#75) 2019-06-17 15:33:49 +01:00
.scalafmt.conf Apply scalafmt (#108) 2019-07-16 07:56:54 +01:00
.travis.yml [sbt,travis] revert most of "publish fat-jar", keeping cli jar name (#97) 2019-06-30 14:38:50 +01:00
build.sbt Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
CHANGELOG.org Replace cats-effect with zio (#117) 2019-07-21 21:02:04 +01:00
LICENSE Create LICENSE 2019-06-07 21:25:23 +01:00
README.org Sync more than one source directory into a single bucket/prefix (#25) 2019-07-12 07:42:42 +01:00

thorp

Synchronisation of files with S3 using the hash of the file contents.

file:https://img.shields.io/codacy/grade/c1719d44f1f045a8b71e1665a6d3ce6c.svg?style=for-the-badge file:https://img.shields.io/maven-central/v/net.kemitix.thorp/thorp_2.12.svg?style=for-the-badge

Originally based on Alex Kudlick's aws-s3-sync-by-hash.

The normal aws s3 sync ... command only uses the time stamp of files to decide what files need to be copied. This utility looks at the md5 hash of the file contents.

Usage

  thorp
  Usage: thorp [options]

    -V, --version         Display the version and quit
    -B, --batch           Enabled batch-mode
    -s, --source <value>  Source directory to sync to S3
    -b, --bucket <value>  S3 bucket name
    -p, --prefix <value>  Prefix within the S3 Bucket
    -i, --include <value> Include matching paths
    -x, --exclude <value> Exclude matching paths
    -d, --debug           Enable debug logging
    --no-global           Ignore global configuration
    --no-user             Ignore user configuration

If you don't provide a source the current diretory will be used.

The --include and --exclude parameters can be used more than once.

The --source parameter can be used more than once, in which case, all files in all sources will be consolidated into the same bucket/prefix.

Batch mode

Batch mode disable the ANSI console display and logs simple messages that can be written to a file.

Configuration

Configuration will be read from these files:

  • Global: /etc/thorp.conf
  • User: ~ /.config/thorp.conf
  • Source: ${source}/.thorp.conf

Command line arguments override those in Source, which override those in User, which override those Global, which override any built-in config.

When there is more than one source, only the first ".thorp.conf" file found will be used.

Built-in config consists of using the current working directory as the source.

Note, that include and exclude are cumulative across all configuration files.

Behaviour

When considering a local file, the following table governs what should happen:

# local file remote key hash of same key hash of other keys action
1 exists exists matches - do nothing
2 exists is missing - matches copy from other key
3 exists is missing - no matches upload
4 exists exists no match matches copy from other key
5 exists exists no match no matches upload
6 is missing exists - - delete

Executable JAR

To build as an executable jar, perform `sbt assembly`

This will create the file `cli/target/scala-2.12/thorp`

Copy this file to your `PATH`.