Makefile

VERSION := $(shell python -m setuptools_scm)
HOSTNAME := $(shell hostname)
S3_PREFIX := s3://rstudio-connect-downloads/connect/rsconnect-python

PACKAGE_NAME ?= rsconnect_python
BDIST_WHEEL ?= dist/$(PACKAGE_NAME)-$(VERSION)-py2.py3-none-any.whl

RUNNER = docker run \
  -it --rm \
  -v $(PWD):/rsconnect \
  -w /rsconnect \
  rsconnect-python:$* \
  bash -c

TEST_COMMAND ?= ./scripts/runtests
SHELL_COMMAND ?= bash

ifneq ($(GITHUB_RUN_ID),)
	RUNNER = bash -c
endif

TEST_ENV =
TEST_ENV += CONNECT_CONTENT_BUILD_DIR="rsconnect-build-test"

ifneq ($(CONNECT_SERVER),)
  TEST_ENV += CONNECT_SERVER=$(CONNECT_SERVER)
endif
ifneq ($(CONNECT_API_KEY),)
  TEST_ENV += CONNECT_API_KEY=$(CONNECT_API_KEY)
endif

# NOTE: See the `dist` target for why this exists.
SOURCE_DATE_EPOCH := $(shell date +%s)
export SOURCE_DATE_EPOCH

.PHONY: all-tests
all-tests: all-images test-3.8 test-3.9 test-3.10 test-3.11 test-3.12

.PHONY: all-images
all-images: image-3.8 image-3.9 image-3.10 image-3.11 image-3.12

image-%:
	docker build -t rsconnect-python:$* --build-arg BASE_IMAGE=python:$*-slim .

shell-%:
	$(RUNNER) '$(SHELL_COMMAND)'

test-%:
	PYTHON_VERSION=$* $(RUNNER) '$(TEST_ENV) $(TEST_COMMAND)'

fmt-%:
	$(RUNNER) 'black .'

.PHONY: .fmt-unsupported
.fmt-unsupported:
	@echo ERROR: This python version cannot run the fmting tools
	@exit 1

lint-%:
	$(RUNNER) 'black --check --diff rsconnect/'
	$(RUNNER) 'flake8 rsconnect/'
	$(RUNNER) 'flake8 tests/'
	# Temporarily use leading '-' so it will continue even if pyright finds issues.
	-$(RUNNER) 'pyright rsconnect/'

.PHONY: .lint-unsupported
.lint-unsupported:
	@echo ERROR: This python version cannot run the linting tools
	@exit 1

.PHONY: clean
clean:
	$(RM) -r \
		./.coverage \
		./.pytest_cache \
		./build \
		./dist \
		./htmlcov \
		./rsconnect_python.egg-info \
		./rsconnect.egg-info

.PHONY: clean-stores
clean-stores:
	@find . -name "rsconnect-python" -o -name "rsconnect_python-*" -o -name "rsconnect-*" | xargs rm -rf

.PHONY: shell
shell: RUNNER = bash -c
shell: shell-3.8

.PHONY: test
test: RUNNER = bash -c
test: test-3.8

.PHONY: lint
lint: RUNNER = bash -c
lint: lint-3.8

.PHONY: fmt
fmt: RUNNER = bash -c
fmt: fmt-3.8

# Documentation targets
.PHONY: docs
docs: docs-clean docs-build

.PHONY: docs-clean
docs-clean:
	rm -rf site

.PHONY: docs-build
docs-build:
	uv venv
	uv pip install ".[docs]"
	uv run mkdocs build

.PHONY: docs-serve
docs-serve:
	uv venv
	uv pip install -e ".[docs]"
	uv run mkdocs serve

.PHONY: version
version:
	@echo $(VERSION)

# NOTE: Wheels won't get built if _any_ file it tries to touch has a timestamp
# before 1980 (system files) so the $(SOURCE_DATE_EPOCH) current timestamp is
# exported as a point of reference instead.
.PHONY: dist
dist:
	./scripts/temporary-rename
	SETUPTOOLS_SCM_PRETEND_VERSION=$(VERSION) pip wheel --no-deps -w dist .
	twine check $(BDIST_WHEEL)
	rm -vf dist/*.egg
	@echo "::set-output name=whl::$(BDIST_WHEEL)"
	@echo "::set-output name=whl_basename::$(notdir $(BDIST_WHEEL))"

.PHONY: install
install:
	pip install $(BDIST_WHEEL)

.PHONY: sync-latest-docs-to-s3
sync-latest-docs-to-s3:
	aws s3 sync --acl bucket-owner-full-control \
		--cache-control max-age=0 \
		site/ \
		$(S3_PREFIX)/latest/docs/

.PHONY: promote-docs-in-s3
promote-docs-in-s3:
	aws s3 sync --delete --acl bucket-owner-full-control \
		--cache-control max-age=300 \
		site/ \
		s3://docs.rstudio.com/rsconnect-python/

RSC_API_KEYS=vetiver-testing/rsconnect_api_keys.json

dev:
	docker compose up -d
	sleep 30
	docker compose exec -T rsconnect bash < vetiver-testing/setup-rsconnect/add-users.sh
	python vetiver-testing/setup-rsconnect/dump_api_keys.py $(RSC_API_KEYS)

dev-stop:
	docker compose down
	rm -f $(RSC_API_KEYS)