sqlalchemy-ctds/Makefile at master · joshuahlang/sqlalchemy-ctds · GitHub

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# -*- makefile-gmake -*-

PACKAGE_NAME = ctds

# Python version support
SUPPORTED_PYTHON_VERSIONS := \
    2.7 \
    3.3 \
    3.4 \
    3.5 \
    3.6

# FreeTDS versions to test against. This should
# be the latest of each minor release.
# Note: These version strings *must* match the versions
# on ftp://ftp.freetds.org/pub/freetds/stable/.
CHECKED_FREETDS_VERSIONS := \
    1.00.55

DEFAULT_PYTHON_VERSION := $(lastword $(SUPPORTED_PYTHON_VERSIONS))
DEFAULT_FREETDS_VERSION := $(lastword $(CHECKED_FREETDS_VERSIONS))

# Ignore warnings, i.e. "Unknown distribution option: 'python_requires'"
SQLALCHEMY_CTDS_VERSION := $(strip $(shell python -W ignore setup.py --version))

# Help
.PHONY: help
help:
	@echo "usage: make [check|clean|coverage|doc|publish|pylint|test]"
	@echo
	@echo "    check"
	@echo "        Run tests against all supported versions of Python and"
	@echo "        the following versions of FreeTDS: $(CHECKED_FREETDS_VERSIONS)."
	@echo
	@echo "    clean"
	@echo "        Clean source tree."
	@echo
	@echo "    coverage"
	@echo "        Generate code coverage for Python source code."
	@echo
	@echo "    doc"
	@echo "        Generate documentation."
	@echo
	@echo "    publish"
	@echo "        Publish egg to pypi."
	@echo
	@echo "    pylint"
	@echo "        Run pylint over all *.py files."
	@echo
	@echo "    test"
	@echo "        Run tests using the default Python version ($(DEFAULT_PYTHON_VERSION)) and"
	@echo "        the default version of FreeTDS ($(DEFAULT_FREETDS_VERSION))."


UNITTEST_DOCKER_IMAGE_NAME = sqlalchemy-ctds-unittest-python$(strip $(1))-$(strip $(2))
SQL_SERVER_DOCKER_IMAGE_NAME := sqlalchemy-ctds-unittest-sqlserver

GH_PAGES_DIR := $(abspath .gh-pages)

.PHONY: clean
clean: stop-sqlserver
	git clean -dfX
	docker images -q sqlalchemy-ctds-unittest-* | xargs -r docker rmi

.PHONY: publish
publish:
	git tag -a v$(SQLALCHEMY_CTDS_VERSION) -m "v$(SQLALCHEMY_CTDS_VERSION)"
	git push --tags
	python setup.py sdist upload


.PHONY: start-sqlserver
start-sqlserver:
	scripts/ensure-sqlserver.sh $(SQL_SERVER_DOCKER_IMAGE_NAME)

.PHONY: stop-sqlserver
stop-sqlserver:
	scripts/remove-sqlserver.sh $(SQL_SERVER_DOCKER_IMAGE_NAME)

# Function to generate a rules for:
#   * building a docker image with a specific Python/FreeTDS version
#   * running unit tests for a specific Python/FreeTDS version
#   * running code coverage for a specific Python/FreeTDS version
#
# $(eval $(call GENERATE_RULES, <python_version>, <freetds_version>))
#
define GENERATE_RULES
.PHONY: docker_$(strip $(1))_$(strip $(2))
docker_$(strip $(1))_$(strip $(2)):
	docker build $(if $(VERBOSE),,-q) \
        --build-arg "FREETDS_VERSION=$(strip $(2))" \
        --build-arg "PYTHON_VERSION=$(strip $(1))" \
        -f Dockerfile \
        -t $(call UNITTEST_DOCKER_IMAGE_NAME, $(1), $(2)) \
        .

.PHONY: test_$(strip $(1))_$(strip $(2))
test_$(strip $(1))_$(strip $(2)): docker_$(strip $(1))_$(strip $(2)) start-sqlserver
	docker run --init --rm --tty \
        --network container:$(SQL_SERVER_DOCKER_IMAGE_NAME) \
        $(call UNITTEST_DOCKER_IMAGE_NAME, $(1), $(2)) \
        ./scripts/unittest.sh

.PHONY: coverage_$(strip $(1))_$(strip $(2))
coverage_$(strip $(1))_$(strip $(2)): docker_$(strip $(1))_$(strip $(2)) start-sqlserver
	docker run --init \
        --workdir /usr/src/sqlalchemy-ctds/ \
        --network container:$(SQL_SERVER_DOCKER_IMAGE_NAME) \
        --name $(call UNITTEST_DOCKER_IMAGE_NAME, $(1), $(2))-coverage \
        $(call UNITTEST_DOCKER_IMAGE_NAME, $(1), $(2)) \
        ./scripts/coverage.sh
	mkdir -p $$@
	docker cp $(call UNITTEST_DOCKER_IMAGE_NAME, $(1), $(2))-coverage:/usr/src/sqlalchemy-ctds/coverage \
        $(abspath $$@)
	docker rm $(call UNITTEST_DOCKER_IMAGE_NAME, $(1), $(2))-coverage
endef

$(foreach PV, $(SUPPORTED_PYTHON_VERSIONS), $(foreach FV, $(CHECKED_FREETDS_VERSIONS), $(eval $(call GENERATE_RULES, $(PV), $(FV)))))

define CHECK_RULE
.PHONY: check_$(strip $(1))
check_$(strip $(1)): $(foreach FV, $(CHECKED_FREETDS_VERSIONS), coverage_$(strip $(1))_$(FV))
endef

$(foreach PV, $(SUPPORTED_PYTHON_VERSIONS), $(eval $(call CHECK_RULE, $(PV))))

define CHECKMETADATA_RULE
.PHONY: checkmetadata_$(strip $(1))
checkmetadata_$(strip $(1)): docker_$(strip $(1))_$(DEFAULT_FREETDS_VERSION)
	docker run --init --rm \
        --workdir /usr/src/sqlalchemy-ctds/ \
        $(call UNITTEST_DOCKER_IMAGE_NAME, $(strip $(1)), $(DEFAULT_FREETDS_VERSION)) \
        ./scripts/checkmetadata.sh
endef

$(foreach PV, $(SUPPORTED_PYTHON_VERSIONS), $(eval $(call CHECKMETADATA_RULE, $(PV))))

.PHONY: check
check: pylint $(foreach PV, $(SUPPORTED_PYTHON_VERSIONS), check_$(PV) checkmetadata_$(PV))

.PHONY: test
test: test_$(DEFAULT_PYTHON_VERSION)_$(DEFAULT_FREETDS_VERSION)

.PHONY: coverage
coverage: coverage_$(DEFAULT_PYTHON_VERSION)_$(DEFAULT_FREETDS_VERSION)

.PHONY: pylint
pylint: docker_$(DEFAULT_PYTHON_VERSION)_$(DEFAULT_FREETDS_VERSION)
	docker run --init --rm \
        --workdir /usr/src/sqlalchemy-ctds/ \
        $(call UNITTEST_DOCKER_IMAGE_NAME, $(DEFAULT_PYTHON_VERSION), $(DEFAULT_FREETDS_VERSION)) \
        ./scripts/pylint.sh

.PHONY: doc
doc: docker_$(DEFAULT_PYTHON_VERSION)_$(DEFAULT_FREETDS_VERSION)
	docker run --init \
        --workdir /usr/src/sqlalchemy-ctds/ \
        --name $(call UNITTEST_DOCKER_IMAGE_NAME, $(DEFAULT_PYTHON_VERSION), $(DEFAULT_FREETDS_VERSION))-doc \
        $(call UNITTEST_DOCKER_IMAGE_NAME, $(DEFAULT_PYTHON_VERSION), $(DEFAULT_FREETDS_VERSION)) \
        ./scripts/doc.sh "$(notdir $(GH_PAGES_DIR))"
	docker cp $(call UNITTEST_DOCKER_IMAGE_NAME, $(DEFAULT_PYTHON_VERSION), $(DEFAULT_FREETDS_VERSION))-doc:/usr/src/sqlalchemy-ctds/$(notdir $(GH_PAGES_DIR)) .
	docker rm $(call UNITTEST_DOCKER_IMAGE_NAME, $(DEFAULT_PYTHON_VERSION), $(DEFAULT_FREETDS_VERSION))-doc

.PHONY: _pre_publish-doc
_pre_publish-doc:
	rm -rf "$(GH_PAGES_DIR)"
	git clone --quiet --branch=gh-pages git@github.com:zillow/sqlalchemy-ctds.git "$(GH_PAGES_DIR)"

.PHONY: _post_publish-doc
_post_publish-doc:
	@if [ -n "`git -C "$(GH_PAGES_DIR)" status -s`" ]; then \
        echo; \
        echo "The sqlalchemy-ctds documentation has changed and should be re-published using: "; \
        echo "    git -C "$(GH_PAGES_DIR)" commit -am \"Documentation updates for sqlalchemy-ctds $(SQLALCHEMY_CTDS_VERSION)\""; \
        echo; \
        git -C "$(GH_PAGES_DIR)" status; \
    fi

.PHONY: publish-doc
publish-doc: _pre_publish-doc doc _post_publish-doc