uplink 0.5.0

Idiomatic and safe Rust binding for the Storj Lib Uplink
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# Makefile special variables #

.DEFAULT_GOAL := lint
SHELL := /bin/bash

# Targets #

.PHONY: build
build:
	cargo build

.PHONY: lint
lint:
	cargo fmt --check
	cargo clippy -- -D clippy::all

## Tests ##
.PHONY:test
test: test-doc test-unit test-integration

.PHONY: test-doc
test-doc:
	cargo test --doc

.PHONY: test-integration
test-integration: integration-tests-env-up tests/.tmp/env
	# We don't use `cargo test --test` because it requires to pass a specific test file name and
	# it doesn't accept a list of files. For being able to only run the integration tests we prefix
	# all the integration tests functions with `integration_` and then filter them with the usual
	# `cargo test` command.
	source tests/.tmp/env; cargo test integration

.PHONY: test-unit
test-unit:
	cargo test --lib

tests/.tmp/env: tests/.tmp/up/storj-up
	$(MAKE) integration-tests-credentials | grep -Ei "^export .+" > tests/.tmp/env
	# TODO: This is a hack to get the AWS_* and STORJ_GATEWAY variables without
	# overriding the access grants because those variable are only available using
	# the storj-up from inside of the container, however, we cannot use the access
	# grants because they use the docker compose service name in the URL rather
	# than localhost and then it doesn't resolve.
	# See: https://github.com/storj/up/issues/45#issuecomment-1288808260
	@cd tests; docker compose exec -T satellite-api storj-up credentials --s3 -e \
		-a http://authservice:8888 -s satellite-api \
		| grep -E 'AWS|STORJ_GATEWAY' >> .tmp/env

.PHONY: integration-tests-credentials
integration-tests-credentials: tests/.tmp/up/storj-up
	@cd tests; .tmp/up/storj-up credentials -e

.PHONY: integration-tests-env-up
integration-tests-env-up:
	cd tests; docker compose up -d

.PHONY: .integration-tests-env-down
.integration-tests-env-down:
	cd tests; docker compose down

tests/.tmp/up/storj-up: tests/.tmp/up
	cd tests/.tmp/up; go build -o storj-up

tests/.tmp/up:
	mkdir -p tests/.tmp
	cd tests/.tmp; git clone https://github.com/storj/up.git
	cd tests/.tmp/up; git checkout v1.0.0

## Publish crate ##
.PHONY: publish-test
publish-test:
	cargo publish --dry-run -vv

.PHONY: _publish-crate
_publish-crate:
	cargo publish

## Clean ##
.PHONY: clean
clean: .integration-tests-env-down
	rm -rf tests/.tmp
	cargo clean