Merge pull request #5508 from learningequality/0.17.x

0.17.2 release into master

Author: benjaoming

.buildkite/build_and_upload_artifact.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+make dockerenvdist
+buildkite-agent artifact upload 'dist/*.whl'
+buildkite-agent artifact upload 'dist/*.zip'
+buildkite-agent artifact upload 'dist/*.tar.gz'
+buildkite-agent artifact upload 'dist/*.pex'
+buildkite-agent artifact upload 'dist/*.exe'

.buildkite/pipeline.yml

@@ -0,0 +1,8 @@
+steps:
+  - label: Build the docker environment
+    command: make dockerenvbuild
+
+  - wait
+
+  - label: Build the python packages and windows installer
+    command: mkdir -p dist && .buildkite/build_and_upload_artifact.sh && docker container prune -f

Dockerfile

@@ -0,0 +1,41 @@
+FROM ubuntu:xenial
+
+# install latest python and nodejs
+RUN apt-get -y update
+RUN apt-get install -y software-properties-common curl
+RUN add-apt-repository ppa:voronov84/andreyv
+RUN curl -sL https://deb.nodesource.com/setup_6.x | bash -
+RUN apt-get -y update && apt-get install -y python2.7 python-pip git nodejs gettext python-sphinx wget
+
+# Install wine and related packages
+RUN dpkg --add-architecture i386 
+RUN apt-get update && apt-get install -y --no-install-recommends git ca-certificates sudo software-properties-common
+RUN add-apt-repository -y ppa:ubuntu-wine/ppa && apt-get -y update && apt-get install --no-install-recommends --assume-yes wine
+
+
+COPY . /kalite
+VOLUME /kalitedist/
+
+# for mounting the whl files into other docker containers
+RUN pip install virtualenv && virtualenv /kalite/kalite_env  --python=python2.7
+RUN /kalite/kalite_env/bin/pip install -r /kalite/requirements_dev.txt \
+	&& /kalite/kalite_env/bin/pip install -r /kalite/requirements_sphinx.txt \
+	&& /kalite/kalite_env/bin/pip install -e /kalite/.
+
+# Override the PATH to add the path of our virtualenv python binaries first so it's python executes instead of
+# the system python.
+ENV PATH=/kalite/kalite_env/bin:$PATH
+ENV KALITE_PYTHON=/kalite/kalite_env/bin/python
+
+# Installer dependencies
+RUN cd /kalite/ && git clone https://github.com/learningequality/ka-lite-installers.git && cd /kalite/ka-lite-installers && git checkout 0.17.x
+RUN cd /kalite/ka-lite-installers/windows && wget http://pantry.learningequality.org/downloads/ka-lite/0.17/content/contentpacks/en.zip
+
+# Build the python packages and the ka-lite windows installer
+CMD cd /kalite && make dist \
+	&& cd /kalite/ka-lite-installers/windows \
+	&& cp -R /kalite/dist/ka_lite_static-*-py2-none-any.whl /kalite/ka-lite-installers/windows \
+	&& export KALITE_BUILD_VERSION=$(/kalite/kalite_env/bin/kalite --version) \
+	&& wine inno-compiler/ISCC.exe installer-source/KaliteSetupScript.iss \
+	&& cp /kalite/dist/* /kalitedist/ \
+	&& cp /kalite/ka-lite-installers/windows/KALiteSetup-$(/kalite/kalite_env/bin/kalite --version).exe /kalitedist/

MANIFEST.in

@@ -21,15 +21,6 @@ recursive-include kalite/database/templates/content_items *sqlite
 # a local development environment
 recursive-exclude kalite/static *
 
-# There are still a couple of files left here, however main part is for build
-# process
-recursive-include data *
-recursive-exclude data/khan *
-
-# Necessary because it's a data directory so they
-# do not get automatically excluded
-recursive-exclude python-packages *pyc
-
 # Docs
 include docs/kalite.1.gz
 kalite/static-docs

Makefile

@@ -15,6 +15,7 @@ help:
 	@echo "release - package and upload a release, options: format=[gztar,zip]"
 	@echo "dist - package locally, options: format=[gztar,zip]"
 	@echo "install - install the package to the active Python's site-packages"
+	@echo "msgids - generates source .po files for CrowdIn"
 
 # used for release and dist targets
 format?=gztar
@@ -70,6 +71,7 @@ coverage:
 	coverage run --source kalite bin/kalite test
 	coverage report -m
 
+
 docs:
 	# rm -f docs/ka-lite.rst
 	# rm -f docs/modules.rst
@@ -85,6 +87,7 @@ man:
 	cli2man bin/kalite -o docs/kalite.1.gz
 
 assets:
+	node --version | grep -q v6 || ( echo "Only tested to support Node.js v6" && exit 1 )
 	npm install --production
 	node build.js
 	KALITE_HOME=.kalite_dist_tmp bin/kalite manage syncdb --noinput
@@ -94,6 +97,12 @@ assets:
 	cp .kalite_dist_tmp/database/data.sqlite kalite/database/templates/
 	bin/kalite manage retrievecontentpack empty en --foreground --template
 
+msgids:
+	export IGNORE_PATTERNS="*/kalite/static-libraries/*,*/LC_MESSAGES/*,*/kalite/packages/dist/*,*/kalite/packages/bundled/django/*,*/kalite/*bundle*.js,*/kalite/*/js/i18n/*.js" ;\
+	cd kalite ;\
+	kalite manage makemessages -len --no-obsolete ;\
+	kalite manage makemessages -len --no-obsolete --domain=djangojs
+
 release: dist man
 	ls -l dist
 	echo "Uploading dist/* to PyPi, using twine"
@@ -106,7 +115,7 @@ sdist: clean docs assets
 	python setup.py sdist --formats=$(format) --static
 	python setup.py sdist --formats=$(format)
 
-dist: clean docs assets
+dist: clean docs assets 
 	# Building assets currently creates pyc files in the source dirs,
 	# so we should delete those...
 	make clean-pyc
@@ -118,3 +127,16 @@ dist: clean docs assets
 
 install: clean
 	python setup.py install
+
+dockerwriteversion:
+	python -c "import kalite; print(kalite.__version__)" > kalite/VERSION
+
+dockerenvclean: 
+	docker container prune -f
+	docker image prune -f
+
+dockerenvbuild: dockerwriteversion
+	docker image build -t learningequality/kalite:$$(cat kalite/VERSION) -t learningequality/kalite:latest .
+
+dockerenvdist: dockerwriteversion
+	docker run -v $$PWD/dist:/kalitedist learningequality/kalite:$$(cat kalite/VERSION)

circle.yml

@@ -1,25 +1,26 @@
 machine:
   python:
     version: 2.7.11
+  node:
+    version: 6.1.0
 
 dependencies:
   cache_directories:
     - "node_modules"
   override:
     - pip install -r requirements_sphinx.txt
     - pip install -e .
-
-test:
-  pre:
+    - make assets
+    - make docs
     - wget -O geckodriver.tar.gz https://github.com/mozilla/geckodriver/releases/download/v0.10.0/geckodriver-v0.10.0-linux64.tar.gz
     - gunzip -c geckodriver.tar.gz | tar xopf -
     - chmod +x geckodriver
     - sudo mv geckodriver /home/ubuntu/bin
+
+test:
+  pre:
     - export PATH="$PATH:/home/ubuntu/bin"
   override:
-    - make assets:
-        parallel: true
-    - make docs
     - kalite start --traceback -v2
     - sleep 6s  # Necessary for server to be ready
     - kalite status

docs/README.md

@@ -73,3 +73,13 @@ interfere with other Python software on your machine like this::
     $> mkvirtualenv my-kalite-env
     $> workon my-kalite-env
     $> pip install ka-lite
+
+
+Running tests
+_____________
+
+
+On Circle CI, we run Selenium 2.53.6 because it works in their environment. However,
+for more recent versions of Firefox, you need to upgrade Selenium::
+
+    pip install selenium\<3.5 --upgrade

docs/developer_docs/environment.rst

@@ -46,7 +46,7 @@ For more information about using Browserify to handle dependencies, please refer
 Building Frontend Code
 ----------------------
 
-The build script uses `node.js <https://nodejs.org/>`_ - to run the build server for production simply run ``node compile_javascript.js``.
+The build script uses `node.js <https://nodejs.org/>`_ - to run the build server for production simply run ``npm install --production`` and ``node build.js`` or build all assets with one command, ``make assets``.
 
 Alternatively, for development, running ``bin/kalite start`` with the ``--watch`` flag will automatically run the build process in watch mode, recompiling Javascript as it changes, on the fly.
 

docs/developer_docs/front_end_code.rst

@@ -13,4 +13,5 @@ Useful stuff our devs think that the rest of our devs ought to know about.
     Inline help <inline>
     Documentation <documentation>
     Accessibility <accessibility>
+    Translation <translation>