Switch to make update-vendored, doc fixes

This commit is contained in:
John Whitlock
2019-12-20 12:31:06 -06:00
parent a06b2078e9
commit cd7ead9042
6 changed files with 34 additions and 33 deletions

View File

@@ -44,7 +44,7 @@ default:
@echo " docs - generate Sphinx HTML documentation, including API docs"
@echo " buildjs - generate js static assets"
@echo " buildcss - generate css static assets"
@echo " download - re-download vendor source and test data"
@echo " update-vendored - re-download vendor source and test data"
@echo ""
@echo " help - see this text"
@echo ""
@@ -133,6 +133,6 @@ runservices: my.env .docker-build
stop: my.env
${DC} stop
.PHONY: download
download: my.env
${DC} run --rm --no-deps app shell make -f docker.make download
.PHONY: update-vendored
update-vendored: my.env
${DC} run --rm --no-deps app shell make -f docker.make update_vendored

View File

@@ -34,19 +34,19 @@ all:
@echo ""
@echo "make rules:"
@echo ""
@echo " build_deps - build datamaps and libmaxmind"
@echo " build_python_deps - install and check python dependencies"
@echo " build_geocalc - compile and install geocalclib"
@echo " check - check that C libraries are available to Python"
@echo " download - download libraries and test data"
@echo " build_deps - build datamaps and libmaxmind"
@echo " build_python_deps - install and check python dependencies"
@echo " build_geocalc - compile and install geocalclib"
@echo " check - check that C libraries are available to Python"
@echo " update_vendored - update libraries and test data"
@echo ""
@echo " build_datamaps - build datamaps binaries"
@echo " build_libmaxmind - build libmaxmind library"
@echo " download_datamaps - download datamaps source"
@echo " download_libmaxmind - download libmaxmind source"
@echo " download_test_data - download MaxMind DB test data"
@echo " build_datamaps - build datamaps binaries"
@echo " build_libmaxmind - build libmaxmind library"
@echo " update_datamaps - update datamaps source"
@echo " update_libmaxmind - update libmaxmind source"
@echo " update_test_data - update MaxMind DB test data"
@echo ""
@echo " help - see this text"
@echo " help - see this text"
build_datamaps:
cd $(VENDOR); tar zxf $(DATAMAPS_NAME).tar.gz
@@ -82,20 +82,20 @@ build_check:
$(PYTHON) -c "import sys; from ichnaea.geoip import GeoIPWrapper; sys.exit(not GeoIPWrapper('ichnaea/tests/data/GeoIP2-City-Test.mmdb').check_extension())"
$(PYTHON) -c "import sys; from ichnaea.geocode import GEOCODER; sys.exit(not GEOCODER.region(51.5, -0.1) == 'GB')"
.PHONY: download_datamaps
download_datamaps:
.PHONY: update_datamaps
update_datamaps:
cd $(VENDOR) && wget -q \
-O $(DATAMAPS_NAME).tar.gz \
https://github.com/ericfischer/datamaps/archive/$(DATAMAPS_COMMIT).tar.gz
.PHONY: download_libmaxmind
download_libmaxmind:
.PHONY: update_libmaxmind
update_libmaxmind:
cd $(VENDOR) && wget -q \
-O $(LIBMAXMIND_NAME).tar.gz \
https://github.com/maxmind/libmaxminddb/releases/download/$(LIBMAXMIND_VERSION)/$(LIBMAXMIND_NAME).tar.gz
.PHONY: download_test_data
download_test_data:
.PHONY: update_test_data
update_test_data:
cd $(TEST_DATA) && wget -q \
-O GeoIP2-City-Test.json \
https://raw.githubusercontent.com/maxmind/MaxMind-DB/master/source-data/GeoIP2-City-Test.json && \
@@ -106,5 +106,5 @@ download_test_data:
-O GeoIP2-Connection-Type-Test.mmdb \
https://github.com/maxmind/MaxMind-DB/raw/master/test-data/GeoIP2-Connection-Type-Test.mmdb
.PHONY: download
download: download_datamaps download_libmaxmind download_test_data
.PHONY: update_vendored
update_vendored: update_datamaps update_libmaxmind update_test_data

View File

@@ -253,17 +253,17 @@ with a web brower.
Updating Test GeoIP Data and Libraries
======================================
The development environment uses a test MaxMind GeoIP database, and a test
confirms that this is less than 1000 days old. To update this database and
confirm tests pass, run::
The development environment uses a test MaxMind GeoIP database, and the Ichnaea
test suite will fail if this is more than 1000 days old. To update this
database and confirm tests pass, run::
$ make download test
$ make update-vendored test
Commit the refreshed files.
This command can also be used to updated `libmaxmindb` and the `datamaps`
source. Update `docker.make` for the desired versions, and run::
This command can also be used to updated ``libmaxmindb`` and the ``datamaps``
source. Update ``docker.make`` for the desired versions, and run::
$ make download build test
$ make update-vendored build test
Commit the updated source tarballs.

View File

@@ -9,4 +9,5 @@ http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to
Creative Commons, 444 Castro Street, Suite 900, Mountain View,
California, 94041, USA
To download fresh copies and confirm they work, run ``make download test``.
To download fresh copies and confirm they work, run
``make update-vendored test``.

View File

@@ -62,7 +62,7 @@ class TestHeartbeat(object):
assert isinstance(data[name]["time"], int)
assert data[name]["time"] >= 0
# Run "make download" when this gets too old
# Run "make update-vendored" when this gets too old
assert 1 < data["geoip"]["age_in_days"] < 1000

2
vendor/README.rst vendored
View File

@@ -3,4 +3,4 @@ Vendor
These tarballs where downloaded from https://github.com/ericfischer/datamaps and
https://github.com/maxmind/libmaxminddb. To download new versions and confirm
they work, update ``docker.make`` and run ``make download build test``.
they work, update ``docker.make`` and run ``make update-vendored build test``.