Merge pull request #6 from jimdigriz/getlic

add kc.lic.py and have travis build docker image

Author: jhanna-kx

.travis.yml

@@ -1,24 +1,37 @@
 language: c
+
 os:
-- linux
-- osx
+  - linux
+  - osx
+
+git:
+  depth: 1
+
 script:
-- make p.so
-- echo "Preparing version $TRAVIS_BRANCH-$TRAVIS_COMMIT"
-- zip -r embedPy_$TRAVIS_OS_NAME-$TRAVIS_BRANCH.zip p.q p.k test.q tests m64/p.so
-  l64/p.so LICENSE README.md || true
-- echo "Packaged as embedPy_$TRAVIS_OS_NAME-$TRAVIS_BRANCH.zip"
-compiler:
-- clang
-- gcc
+  - export PROJECT=$(echo $TRAVIS_REPO_SLUG | cut -d/ -f2-)
+  - if [ $TRAVIS_OS_NAME = linux ]; then QLIBDIR=l64; elif [ $TRAVIS_OS_NAME = osx ]; then QLIBDIR=m64; else echo "unknown OS ('$TRAVIS_OS_NAME')" >&2; exit 1; fi; export QLIBDIR
+  - make $QLIBDIR/p.so
+  - tar czf ${PROJECT}_${TRAVIS_TAG}_${TRAVIS_OS_NAME}.tgz LICENSE p.q p.k $QLIBDIR/p.so
+
 deploy:
   provider: releases
-  api_key: "$GITHUB_APIKEY"
-  file_glob: true
-  file: embedPy_*.zip
+  api_key: $GITHUB_OAUTH_TOKEN
+  file: ${PROJECT}_${TRAVIS_TAG}_${TRAVIS_OS_NAME}.tgz
   skip_cleanup: true
   on:
     tags: true
-notifications:
-  slack:
-    secure: "MR5icOywJJSFy7gnxeNXACN2nKiHniVgX1myiF+H9U4wsW6+2BHzPMcmy3FIUjL3Tb+PcAfq7+8RHerAx/XEB7nsVJsu9TyCjYWgaqx5Z9WNIDcjQh4wnFurhlzqrwF4gjelY+wxdffpsKUVaP+fermWbqHvv1aPPk4l3xEonXZ5J5uNkPTPufILzpx2cTxWg08o6PhvgjTrombs+9rGxahU8cfUSwTVuPCcPtOy70kcaowFfrU2kWzQk88NM5d/TVZdkOmGhLqVWSvRgaLXFkGYwRWatT7divlXX2evYwdYib++RUUhxDGZwJjdFCbGDNjrMyBbJOrCkndxLSATd6gN76dWuWsVV49K4YB0Mw5uFJFt6J0TnbkJC5Zsl9i6vik7m3anuIPOeAI54/wtlCvMeIpt2eQCPMy7xXu2hXNUR4ofM4yaVjKz69b5JIZ1o3vBxPQxAqIYggqPsTaLJM4vLpZlncnViBkfO/La5V9sJNQy3IyLSlEKry3giYfo8wbHT3PLn1xG7HW2DJ7hRn19yzTkCCNfaSzvq8YlSQvjNlPCO566ykYYG6SzG/NnbDqJAqydhpFuNC7ZB5dPuAOoDANCGs4gtfYKia+ZVxKYn25Y52vdi34L5TO83BUrsQWgytb0J6a4jDe3PWLVFSP7XLiy4h8Tyv76+Hm4lHk="
+
+jobs:
+  include:
+    - stage: docker
+      sudo: required
+      services:
+        - docker
+      script:
+        - eval ${DOCKER_IMAGE:+docker build -t $DOCKER_IMAGE -f docker/Dockerfile .}
+      deploy:
+        provider: script
+        script: eval ${DOCKER_IMAGE:+echo $DOCKER_API_KEY | docker login --username $DOCKER_USERNAME --password-stdin && docker push $DOCKER_IMAGE}
+        skip_cleanup: true
+        on:
+          tags: true

README.md

@@ -50,30 +50,66 @@ To install, place `p.q` and `p.k` in `$QHOME` and `p.so` in `$QHOME/{l64,m64}`.
 
 ### Docker
 
-If you have [Docker installed](https://www.docker.com/community-edition) you can alternatively create a directory called `q` and place your `kc.lic` (or `k4.lic`) file into a `q` directory and run:
+If you have [Docker installed](https://www.docker.com/community-edition) you can alternatively run:
 
-    $ docker run --rm -it -v `pwd`/q:/tmp/q kxsys/embedpy
-    kx@1ba5d6c29709:~$ q
-    KDB+ 3.5 2017.11.08 Copyright (C) 1993-2017 Kx Systems
-    l64/ 4(16)core 7905MB kx 0123456789ab 172.17.0.2 EXPIRE 2018.12.04 [email protected] KOD #0000000
+    $ docker run -it --name myembedpy kxsys/embedpy
+    kdb+ on demand - Personal Edition
+    
+    [snipped]
+    
+    I agree to the terms of the license agreement for kdb+ on demand Personal Edition (N/y): y
+    
+    If applicable please provide your company name (press enter for none): ACME Limited
+    Please provide your name: Bob Smith
+    Please provide your email (requires validation): [email protected]
+    KDB+ 3.5 2018.04.25 Copyright (C) 1993-2018 Kx Systems
+    l64/ 4()core 7905MB kx 0123456789ab 172.17.0.2 EXPIRE 2018.12.04 [email protected] KOD #0000000
+    
+    q)
+
+For subsequent runs, you will not be prompted to redo the license setup when calling:
 
+    $ docker start -ai myembedpy
+    KDB+ 3.5 2018.04.25 Copyright (C) 1993-2018 Kx Systems
+    l64/ 4()core 7905MB kx 0123456789ab 172.17.0.2 EXPIRE 2018.12.04 [email protected] KOD #0000000
+    
     q)
 
-You can drop straight into `bash` with:
+If you prefer to drop straight into `bash` you can with:
 
-    $ docker run --rm -it -v `pwd`/q:/tmp/q kxsys/embedpy bash
+    $ docker run -it kxsys/embedpy bash
+    [snipped license setup]
     kx@8ac226623908:~$ conda info
 
          active environment : kx
         active env location : /home/kx/.conda/envs/kx
     [snipped]
+    kx@8ac226623908:~$ q
+    KDB+ 3.5 2018.04.25 Copyright (C) 1993-2018 Kx Systems
+    l64/ 4()core 7905MB kx 0123456789ab 172.17.0.2 EXPIRE 2018.12.04 [email protected] KOD #0000000
+    
+    q)
 
-Lastly you can also pipe your program in:
+**N.B.** [build instructions for the image are available](docker/README.md)
 
-    $ echo 'p)print(1+2)' | docker run --rm -i -v `pwd`/q:/tmp/q kxsys/embedpy q -q
-    3
+#### Headless/Presets
 
-**N.B.** [build instructions for the image are available](docker/README.md)
+If you are running this in a headless configuration, or wish to provide out-of-bound the answers to the license process, then you can call upon the following environment variables.  This is handled either by [`--env` (or `--env-file`) as detailed on the docker website](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file).
+
+ * **`KDB_LICENSE_AGREE`:** pass in `yes` (case-insensitive) to agree to the license agreement
+ * **`COMPANY` (optional):** provide company name
+ * **`NAME`:** provide your name
+ * **`EMAIL`:** provide your email address
+
+If any of these are missing, then you will be prompted for the value as before.
+
+**N.B.** alternatively you can use `QLIC_KC` (also supported is `QLIC_K4`) which is the base64 encoded contents of your `kc.lic` file
+
+This allows for the following usage:
+
+    $ echo \\\\ | docker run -i -e QLIC_KC=$(cat $QHOME/kc.lic | base64 -w0) --name myembedpy embedpy q -q
+    $ echo 'p)print(1+2)' | docker start -i myembedpy
+    3
 
 ## Usage
 

docker/Dockerfile

@@ -65,8 +65,10 @@ RUN mkdir -p $QHOME
 RUN curl -o $QHOME/l64.zip -L http://dls.kx.com/253h1j3s2941/download/l64.zip \
 	&& [ "$L64_SHA256" = "$(sha256sum $QHOME/l64.zip | cut -b1-64)" ] \
 	&& unzip -d $QHOME $QHOME/l64.zip \
-	&& rm $QHOME/l64.zip
+	&& rm $QHOME/l64.zip \
+	&& apt-get -yy --option=Dpkg::options::=--force-unsafe-io purge unzip
 COPY docker/q.wrapper /usr/local/bin/q
+COPY docker/kc.lic.py /opt/kx/
 
 COPY --from=embedpy /opt/kx/embedPy /opt/kx/embedPy
 RUN ln -s -t $QHOME/l64 /opt/kx/embedPy/l64/p.so \

docker/README.md

@@ -1,8 +1,4 @@
-The instructions below are for building your own docker image. A prebuilt docker image is available on docker cloud, if you only want to run the embedpy image then install docker and run
-
-```bash
-docker run -it -v `pwd`/q:/tmp/q kxsys/embedpy
-```
+The instructions below are for building your own Docker image. A prebuilt Docker image is available on Docker Cloud, if you only want to run the embedPy image then install Docker and [read the main instructions](https://github.com/KxSystems/embedPy#docker) on how to do this.
 
 # Preflight
 
@@ -18,16 +14,13 @@ To build locally the project you run:
 
     docker build -t embedpy -f docker/Dockerfile .
 
-Other build arguments are supported and you should browse the `Dockerfile` to see what they are, but note for Docker Cloud you will need to make sure they are also explicitly exported in [`docker/hooks/build`](hooks/build) too.
-
 Once built, you should have a local `embedpy` image, you can run the following to use it:
 
-    docker run -it -v `pwd`/q:/tmp/q embedpy
-
+    docker run -it embedpy
 
 # Deploy
 
-[Google Cloud Builder](https://cloud.google.com/container-builder/docs/) is configured to monitor when tags of the format `/^[0-9.]+/` are added to the [GitHub hosted project](https://github.com/KxSystems/embedPy), a corresponding Docker image is generated and made available on docker [Docker Cloud](https://cloud.docker.com/)
+[Google Cloud Builder](https://cloud.google.com/container-builder/docs/) is configured to monitor when tags of the format `/^[0-9.]+/` are added to the [GitHub hosted project](https://github.com/KxSystems/embedPy), a corresponding Docker image is generated and made available on [Docker Cloud](https://cloud.docker.com/)
 
 This is all done server side as the resulting image is north of 350MB.
 
@@ -37,9 +30,9 @@ To do a deploy, you simply tag and push your releases as usual:
     git tag 0.7
     git push --tag
 
+## Travis Option
 
 ## Related Links
 
  * [Docker](https://docker.com)
      * [`Dockerfile`](https://docs.docker.com/engine/reference/builder/)
-

docker/hooks/build

@@ -2,22 +2,6 @@
 
 set -eu
 
-[ -d /tmp/q ] \
-	|| { echo q non-functional, did you include the q directory? >&2; exit 1; }
-
-[ -f /tmp/q/kc.lic ] && cat /tmp/q/kc.lic > "$QHOME/kc.lic" || true
-[ -f /tmp/q/k4.lic ] && cat /tmp/q/k4.lic > "$QHOME/k4.lic" || true
-[ -f "$QHOME/kc.lic" -o -f "$QHOME/k4.lic" ] \
-	|| { echo missing kc.lic/k4.lic >&2; exit 1; }
-
-[ "$(echo '-1 getenv`QHOME;' | q -q)" = "$QHOME" ] \
-	|| { echo q non-functional >&2; exit 1; }
-
-RC=0
-CHECK=$(echo '.z.K>=3.5' | q -q) || RC=$?
-[ $RC -eq 0 ] || { echo q non-functional >&2; exit 1; }
-[ "$CHECK" = "1b" ] || { echo "kdb+ version must be >= 3.5" >&2; exit 1; }
-
 if ! test -x "$1"; then
 	SH=$(which "$1")
 	shift
@@ -33,4 +17,8 @@ fi
 
 HOME=/home/kx
 cd $HOME
+
+export QLIC=$HOME
+chpst -u kx /bin/sh -l -c 'exec python /opt/kx/kc.lic.py'
+
 exec chpst -u kx "$@"