Migrate to an Alpine-based image & introduce a test suite #39

dduportal · 2017-03-22T11:33:57Z

This Pull Requests follows up #24 .

It introduces:

A Test suite (using BATS ) to validate behaviour of the image
- I don't cover ALL the use cases. This should be done on the fly ala BDD philosophy
- We can see this test suite as an auto-generated "tech reference" of the image
Alpine Linux based image:
- The final image weight around 470 Mb, which way less than the ~1,55 Gb of the original image
- asciidoctor Alpine Linux Package is used, but not only
Asciidoctor-pdf is currently suffering (until next release) from a prawn dependency non wanted behaviour. This PR adds the short-term solution from @mojavelinux . More details here: can't modify frozen Array (RuntimeError) asciidoctor-pdf#772
"Plumbing sugar": gitignore, dockerignore, gitattributes (force unix eol)
What can be improved (WiP):
- Using the Asciidoctor fixed version for the Alpine package
- Using Travis CI (or any other free hosted CI) for building and testing, providing Pull Request feedback and confidence
Image can be tested from here (build time can be annoying): https://hub.docker.com/r/dduportal/docker-asciidoctor/ (it is a TEMPORARY docker image, do not use it outside testing !)

Now it's your turn to give feedbacks !

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Cleaning Docker image and tests Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

…asciidoctor-pdf#772 Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Travis Init Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Travis wip Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Travis wip Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

dduportal · 2017-03-22T11:40:40Z

Travis CI build added. Feel free to stop me here if you do not use Travis for the asciidoctor organization. I can provide Jenkinsfile or Circle CI yml as well.

Build example here: https://travis-ci.org/dduportal/docker-asciidoctor/builds/213795084

FYI, a good CD pipeline could be:

Run Travis CI (or any other CI tools) that run the test suite (that takes care of locally building the image)
If test suite is passing, then, as a post-step, send a webhook to the DockerHub to launch the autobuild.

mojavelinux · 2017-03-23T07:46:36Z

A Test suite

You are my hero already. This is the greatest gift to any project.

mojavelinux · 2017-03-23T07:47:25Z

Asciidoctor-pdf is currently suffering (until next release) from a prawn dependency non wanted behaviour.

I'll have a new release out by the end of the weekend, hopefully even sooner.

mojavelinux · 2017-03-23T07:48:15Z

Feel free to stop me here if you do not use Travis for the asciidoctor organization.

Stop you? I'm going to give you 🍾 🍾 🍾

(And yes, we mostly use Travis in Asciidoctor)

mojavelinux · 2017-03-23T07:56:15Z

I'm going to note some things for the future, but I don't want them to hold up this PR, which is great:

Consider making a derivative image that adds fopub (aka the DocBook toolchain); we're trying to move away from that and, while there are still people that need it, it should be separate
I'm not convinced we need to install lazybones (though I do like that we're setting up sdkman)
Consider adding Asciidoctor Mathematical

mojavelinux · 2017-03-23T07:49:10Z

.gitignore

@@ -0,0 +1 @@
+tmp


I prefer to make gitignore entries very specific so that they don't catch entries anywhere in the hierarchy. Thus:

/tmp/

👍 I'll update it

mojavelinux · 2017-03-23T07:50:23Z

Dockerfile

-ENV ASCIIDOCTOR_VERSION "1.5.5"
+ENV JAVA_HOME=/usr/lib/jvm/default-jvm \
+  PATH=${PATH}:${JAVA_HOME}/bin:/fopub/bin \
+  BACKENDS=/asciidoctor-backends \


Now that we've made separate gems for reveal.js and bespoke.js, I'm strongly considering dropping the backends from this image. If people disagree, I'm willing to change my mind.

mojavelinux · 2017-03-23T07:51:31Z

Dockerfile

  && gem install --no-ri --no-rdoc asciidoctor-diagram \
  && gem install --no-ri --no-rdoc asciidoctor-epub3 --version 1.5.0.alpha.6 \
+  && gem install --no-ri --no-rdoc asciidoctor-revealjs \
  && gem install --no-ri --no-rdoc rake \
  && gem install --no-ri --no-rdoc epubcheck --version 3.0.1 \
  && gem install --no-ri --no-rdoc kindlegen --version 3.0.1 \


We should move to kindlegen 3.0.3. I've verified it (on another project) and it works.

👍 I'll update it

bartoszmajsak · 2017-03-23T08:50:51Z

That is awesome :) I will grab tmp image and give it a spin for generating @arquillian docs.

bartoszmajsak · 2017-03-23T08:53:16Z

tests/test_suite.bats

+  docker run -t --rm \
+    -v "${BATS_TEST_DIRNAME}":/documents/ \
+    "${DOCKER_IMAGE_NAME}" \
+      asciidoctor-pdf -D /documents/tmp /documents/fixtures/basic-example.adoc


I assume we won't change the content of HTML and PDF. Would it make sense to generate it and use to compare against what docker container produces?

If we see a value in it I can contribute.

Hello @bartoszmajsak this totally make sense !

But let's go step by step (I like starting slowly and then improve):
If you're willing to do it now, you can easily fork my fork branch, start your own tests.
THen when you'll have finished, it will be easy to merge on my repo or in this, based on the status of this PR at that moment (power of decentralized tools).

Sure, just wanted to hear your thoughts. It's not for this PR per se, but I will work on it soon.

Yup, no problem. Thanks for this, this is a great idea !

jirutka · 2017-03-23T10:08:53Z

Dockerfile

-    rubygem-nokogiri \
+    jpeg \
+    jpeg-dev \
+    openjdk8 \


openjdk8-jre-base should be sufficient here. openjdk8 is complete JDK including dependencies for desktop apps.

AFAIK, this come from fopub tool: https://github.com/asciidoctor/asciidoctor-fopub#prerequisites . But given @mojavelinux comment below (#39 (comment) ) , this would be a great move if we got out the jdk to the jre (even not using java at all in this image)

jirutka · 2017-03-23T10:12:00Z

Dockerfile

+    jpeg-dev \
+    openjdk8 \
+    patch \
+    python \


This package was renamed to python2 (python2-dev).

👍 I'll update it

jirutka · 2017-03-23T10:14:20Z

Dockerfile

+  && mkdir "${BACKENDS}" \
+  && (curl -LkSs https://api.github.com/repos/asciidoctor/asciidoctor-backends/tarball | tar xfz - -C "${BACKENDS}" --strip-components=1) \
+  && ln -s /usr/bin/easy_install-2.7 /usr/local/bin/easy_install \
+  && easy_install 'blockdiag[pdf]' \


easy_install is ancient crap that should not be used anymore, use pip instead.

👍 I'll update it

dduportal · 2017-03-23T10:19:03Z

Based on this first set of feedbacks (Thanks you all !), here is the task list for this PR (I'll take it updated on the fly):

.gitignore more specific for the tmp dir (and/or use the BATS_TMP_DIR instead)
Upgrade kindlegen gem
Remove Backends (at least for this PRn, and see if people don't like it)
Remove fopub and open an issue for tracking creation of a derivative image (using docker-compose to combine with this one ?) + remove java instead of needed
python: use the right packages
pip instead of easy_install
Remove lazybone but keep sdkman installed (not very heavy)
Install Asciidoctor mathematical https://github.com/asciidoctor/asciidoctor-mathematical#installation

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Python 2 package dev cleanup Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

dduportal · 2017-07-10T11:01:53Z

Hello, thanks for the notice @jirutka !

It has been updated to alpine 3.6, with Gems updates also (asciidoctor pdf and asciidocotr alpine packer to r1).

Ping @mojavelinux if it is ok for you to merge ?

jirutka · 2017-10-02T13:19:38Z

@mojavelinux Why is this still not merged?

madpipeline · 2017-10-02T15:29:02Z

@jirutka I've been wondering the same thing for months

wimdeblauwe · 2017-10-04T13:06:04Z

I would love to see this happen as well. Seems the current version on dockerhub is still using asciidoctor 1.5.5 (https://hub.docker.com/r/dduportal/docker-asciidoctor/~/dockerfile/).

wimdeblauwe · 2017-10-04T13:22:42Z

Just a heads up that I tried the image but I get the following error if I want to use asciidoctor diagram:

 asciidoctor-diagram: ERROR: Failed to generate image: Could not find Java executable

I used the latest version of the code in this PR + I replaced version 3.6 with edge for the Linux and set asciidoctor version to 1.5.6.1-r0

jirutka · 2017-10-04T14:00:31Z

I get the following error if I want to use asciidoctor diagram:
asciidoctor-diagram: ERROR: Failed to generate image: Could not find Java executable

Well, that’s no surprising, there’s no openjdk-jre-base package in the dockerfile. However, why does it need Java? o.O

I replaced version 3.6 with edge…

That’s not a good idea, edge is unstable.

dduportal · 2017-10-06T12:10:05Z

Hello @wimdeblauwe @jirutka! Thanks for your feedbacks!
About the missing java in the image, it comes from @mojavelinux
comment at the beginning of the current PR: #39 (comment)
=> One strategy would be having a dedicated tag or image with java embedded to cover this. The tradeoff here is that a lot of the user might not need the java, but are interested in a lightweight image. But still, in term of usability, the end-user should not have to care about this.
=> Maybe a composed image could be a solution, with the new https://docs.docker.com/engine/userguide/eng-image/multistage-build/ .

Ping @mojavelinux we need you or a maintainer to merge this in order to iterate. I am willing to help, even maintaining if you need help or time.

jirutka · 2017-10-06T12:27:49Z

@dduportal I pinged @mojavelinux on Twitter and asked him to give you a write access. It really sucks to wait months for response/approval.

dduportal · 2017-10-06T13:12:28Z

Thanks @jirutka . I would not say that "it sucks" because I already had issues to cover all requests on my very tiny personnal projects, so I can understand the overloading for @mojavelinux .

By the way, willing to maintain will help I hope :)

mojavelinux · 2017-10-12T08:26:59Z

It's definitely time (maybe even past time) to make this switch. We're all ready for it and other requests are getting backed up because this isn't merged yet. While I could merge, I would only just be pressing a button, not testing it. Therefore, I'm granting @dduportal admin rights on the repository. @dduportal you can choose to maintain it or grant permission to another trust member of the community willing to step forward. You've demonstrated your skill set in this issue and I trust you to be the one who merges it. We all appreciate your contribution. I want to empower you to continue this work.

dduportal · 2017-10-12T20:35:18Z

Thanks @mojavelinux for this trust.

Just tested again and it is working on my Mac, on Travis, and on my remote Ubuntu server.

Now merging and taking care of any issue question from now.

mojavelinux · 2017-10-12T20:53:25Z

👏

PR asciidoctor#39 which moved the image to alpine has also thrown out make, which is quite handy for more complicated build scenarios.

dduportal added 8 commits March 22, 2017 10:36

Moving Dockerfile to Alpine Linux

f665376

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Implementing basic test suites with bats

37092ed

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Cleaning Docker image and tests Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Asciidoctor PDF need prawn 2.1.0 to avoid Frozen array - asciidoctor/…

6b13ab6

…asciidoctor-pdf#772 Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Lightweight image

bc76bda

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Travis Init

ef96e78

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Travis Init

ed0dd07

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Travis wip

daee407

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Travis wip

d04da1a

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

dduportal mentioned this pull request Mar 22, 2017

WiP : Moving to Alpine image #24

Closed

mojavelinux requested changes Mar 23, 2017

View reviewed changes

mojavelinux changed the title ~~Moving to an Alpine based image + introducing test suite (follow #24)~~ Migrate to an Alpine-based image & introduce a test suite Mar 23, 2017

bartoszmajsak reviewed Mar 23, 2017

View reviewed changes

jirutka reviewed Mar 23, 2017

View reviewed changes

dduportal added 7 commits March 23, 2017 13:50

Adding documentation for contribution + specializing the gitignore

21a605c

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Kindlegen Gem upgrade

627dc77

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Using the right Alpine python package

cbd3848

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com> Python 2 package dev cleanup Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Moving to pip instead of easy_install

2b6358b

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Using the provided asciidoc version and cleaning maintainers label

94954e5

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Remove backends

2d52dfd

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

SDKman test + not installing lazybones anymore

122e65e

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

Upgrade to alpine 3.6 + some GEM updates

db76f1c

Signed-off-by: Damien DUPORTAL <damien.duportal@gmail.com>

mojavelinux mentioned this pull request Jul 29, 2017

Update to Asciidoctor EPUB 1.5.0.alpha.7 #41

Closed

mojavelinux approved these changes Oct 12, 2017

View reviewed changes

dduportal merged commit ed77567 into asciidoctor:master Oct 12, 2017

dduportal deleted the alpine branch October 12, 2017 20:35

dduportal mentioned this pull request Oct 12, 2017

Use Alpine Docker image #13

Closed

mojavelinux mentioned this pull request Oct 13, 2017

asciidoctor-diagram doesn't work on alpine based image #44

Closed

rassie added a commit to rassie/docker-asciidoctor that referenced this pull request Oct 13, 2017

Re-include "make"

fac06a4

PR asciidoctor#39 which moved the image to alpine has also thrown out make, which is quite handy for more complicated build scenarios.

rassie mentioned this pull request Oct 13, 2017

Re-include "make" #45

Merged

rassie added a commit to rassie/docker-asciidoctor that referenced this pull request Oct 16, 2017

Re-include "make"

d4c13d8

PR asciidoctor#39 which moved the image to alpine has also thrown out make, which is quite handy for more complicated build scenarios.

This was referenced Oct 22, 2017

[Proposal] Continuous Deployment process of the image with Travis #49

Closed

Study & Improve Image Size #50

Open

dduportal mentioned this pull request Nov 7, 2017

asciidoctor-mathematical Missing fonts #55

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to an Alpine-based image & introduce a test suite #39

Migrate to an Alpine-based image & introduce a test suite #39

dduportal commented Mar 22, 2017

dduportal commented Mar 22, 2017

mojavelinux commented Mar 23, 2017

mojavelinux commented Mar 23, 2017

mojavelinux commented Mar 23, 2017 •

edited

Loading

mojavelinux commented Mar 23, 2017

mojavelinux Mar 23, 2017

dduportal Mar 23, 2017

mojavelinux Mar 23, 2017

mojavelinux Mar 23, 2017

dduportal Mar 23, 2017

bartoszmajsak commented Mar 23, 2017

bartoszmajsak Mar 23, 2017

dduportal Mar 23, 2017

bartoszmajsak Mar 23, 2017 •

edited

Loading

dduportal Mar 23, 2017

jirutka Mar 23, 2017

dduportal Mar 23, 2017

jirutka Mar 23, 2017

dduportal Mar 23, 2017 •

edited

Loading

jirutka Mar 23, 2017

dduportal Mar 23, 2017

dduportal commented Mar 23, 2017 •

edited

Loading

dduportal commented Jul 10, 2017

jirutka commented Oct 2, 2017

madpipeline commented Oct 2, 2017

wimdeblauwe commented Oct 4, 2017

wimdeblauwe commented Oct 4, 2017

jirutka commented Oct 4, 2017

dduportal commented Oct 6, 2017

jirutka commented Oct 6, 2017

dduportal commented Oct 6, 2017

mojavelinux commented Oct 12, 2017

dduportal commented Oct 12, 2017

mojavelinux commented Oct 12, 2017

Migrate to an Alpine-based image & introduce a test suite #39

Migrate to an Alpine-based image & introduce a test suite #39

Conversation

dduportal commented Mar 22, 2017

dduportal commented Mar 22, 2017

mojavelinux commented Mar 23, 2017

mojavelinux commented Mar 23, 2017

mojavelinux commented Mar 23, 2017 • edited Loading

mojavelinux commented Mar 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bartoszmajsak commented Mar 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bartoszmajsak Mar 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dduportal Mar 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dduportal commented Mar 23, 2017 • edited Loading

dduportal commented Jul 10, 2017

jirutka commented Oct 2, 2017

madpipeline commented Oct 2, 2017

wimdeblauwe commented Oct 4, 2017

wimdeblauwe commented Oct 4, 2017

jirutka commented Oct 4, 2017

dduportal commented Oct 6, 2017

jirutka commented Oct 6, 2017

dduportal commented Oct 6, 2017

mojavelinux commented Oct 12, 2017

dduportal commented Oct 12, 2017

mojavelinux commented Oct 12, 2017

mojavelinux commented Mar 23, 2017 •

edited

Loading

bartoszmajsak Mar 23, 2017 •

edited

Loading

dduportal Mar 23, 2017 •

edited

Loading

dduportal commented Mar 23, 2017 •

edited

Loading