-
Notifications
You must be signed in to change notification settings - Fork 1
/
Makefile
175 lines (146 loc) · 5.39 KB
/
Makefile
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
################################################################################
# #
# Cisco Systems Proprietary Software #
# Not to be distributed without consent from Test Technology #
# Cisco Systems, Inc. #
# #
################################################################################
# genie.webdriver Internal Makefile
#
# Author:
# pyats-support@cisco.com
#
# Support:
# pyats-support@cisco.com
#
# Version:
# v2.0
#
# Date:
# December 2018
#
# About This File:
# This script will build the genie.webdriver package for
# distribution in PyPI server
#
# Requirements:
# 1. Module name is the same as package name.
# 2. setup.py file is stored within the module folder
################################################################################
# Variables
PKG_NAME = genie.webdriver
BUILD_DIR = $(shell pwd)/__build__
DIST_DIR = $(BUILD_DIR)/dist
STAGING_PKGS = /auto/pyats/staging/packages
STAGING_EXT_PKGS = /auto/pyats/staging/packages_external
PYTHON = python3
TESTCMD = ./tests/runAll --path=./tests/
BUILD_CMD = $(PYTHON) setup.py bdist_wheel --dist-dir=$(DIST_DIR)
PYPIREPO = pypitest
PROD_USER = pyadm@pyats-ci
# Development pkg requirements
DEPENDENCIES = restview psutil Sphinx wheel asynctest
DEPENDENCIES += setproctitle sphinx-rtd-theme
DEPENDENCIES += pip-tools
# Dependencies for building documentation
# pinning sphinx as it creates dependancy issues with jinja2 and markupsafe
DOCS_DEPENDENCIES = Sphinx==5.0.0 sphinxcontrib-napoleon sphinxcontrib-mockautodoc sphinx-rtd-theme
.PHONY: clean package distribute develop undevelop help devnet\
docs test install_build_deps uninstall_build_deps install_build_deps \
distribute_staging distribute_staging_external
help:
@echo "Please use 'make <target>' where <target> is one of"
@echo ""
@echo "package Build the package"
@echo "test Test the package"
@echo "distribute Distribute the package to internal Cisco PyPi server"
@echo "distribute_staging Distribute build pkgs to staging area"
@echo "distribute_staging_external Distribute build pkgs to external staging area"
@echo "clean Remove build artifacts"
@echo "develop Build and install development package"
@echo "undevelop Uninstall development package"
@echo "docs Build Sphinx documentation for this package"
@echo "install_build_deps: Install build dependencies for docs (will be run in make docs)"
html: docs
docs:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Building $(PKG_NAME) documentation for preview: $@"
@echo ""
sphinx-build -M html docs/ $(BUILD_DIR)/documentation
@echo "Completed building docs for preview."
test:
@$(TESTCMD)
uninstall_build_deps:
@echo "no op"
install_build_deps:
@echo "Installing build dependecies into your environment"
@pip install $(DOCS_DEPENDENCIES)
@echo ""
@echo "Done"
package:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Building $(PKG_NAME) distributable: $@"
@echo ""
$(BUILD_CMD)
@echo ""
@echo "Completed building: $@"
@echo ""
@echo "Done."
@echo ""
develop:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Building and installing $(PKG_NAME) development distributable: $@"
@echo ""
@pip install $(DEPENDENCIES);
@$(PYTHON) setup.py develop --no-deps -q
@pip install -e ".[dev]"
@echo ""
@echo "Completed building and installing: $@"
@echo ""
@echo "Done."
@echo ""
undevelop:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Uninstalling $(PKG_NAME) development distributable: $@"
@echo ""
@$(PYTHON) setup.py develop --no-deps -q --uninstall
@echo ""
@echo "Completed uninstalling: $@"
@echo ""
@echo "Done."
@echo ""
clean:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Removing make directory: $(BUILD_DIR)"
@rm -rf $(BUILD_DIR) $(DIST_DIR)
@echo ""
@echo "Removing build artifacts ..."
@$(PYTHON) setup.py clean
@echo ""
@echo "Done."
@echo ""
distribute_staging:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Copying all distributable to $(STAGING_PKGS)"
@test -d $(DIST_DIR) || { echo "Nothing to distribute! Exiting..."; exit 1; }
@ssh -q $(PROD_USER) 'test -e $(STAGING_PKGS)/$(PKG_NAME) || mkdir $(STAGING_PKGS)/$(PKG_NAME)'
@scp $(DIST_DIR)/* $(PROD_USER):$(STAGING_PKGS)/$(PKG_NAME)/
@echo ""
@echo "Done."
@echo ""
distribute_staging_external:
@echo ""
@echo "--------------------------------------------------------------------"
@echo "Copying all distributable to $(STAGING_EXT_PKGS)"
@test -d $(DIST_DIR) || { echo "Nothing to distribute! Exiting..."; exit 1; }
@ssh -q $(PROD_USER) 'test -e $(STAGING_EXT_PKGS)/$(PKG_NAME) || mkdir $(STAGING_EXT_PKGS)/$(PKG_NAME)'
@scp $(DIST_DIR)/* $(PROD_USER):$(STAGING_EXT_PKGS)/$(PKG_NAME)/
@echo ""
@echo "Done."
@echo ""