Make gif generation CI compatible

Author: romanowski

.github/workflows/ci.yml

@@ -161,7 +161,9 @@ jobs:
       run: .github/scripts/check_docs.sh
 
     - name: Test gifs
-      run: gifs/generate_gifs.sh $(ls gifs/scenarios/) 
+      run: |
+        SKIP_RENDER=true
+        gifs/generate_gifs.sh $(ls gifs/scenarios/) 
 
   checks:
     timeout-minutes: 15

gifs/demo-magic.sh

@@ -196,9 +196,18 @@ function updateFile(){
 
   p "cat $1"
   rougify --theme tulip $1
+  
   sleep 1
 }
 
+function clearConsole(){
+  clear
+}
+
+function doSleep(){
+  sleep $1
+}
+
 check_pv
 #
 # handle some default params

gifs/demo-no-magic.sh

@@ -0,0 +1,44 @@
+# Mock of demo magic, for running on CI
+
+function p() {
+  echo "running: $@"
+}
+
+function pe() {
+  p "$@"
+  run_cmd "$@"
+}
+
+function pei {
+  NO_WAIT=true pe "$@"
+}
+
+function cmd() {
+  run_cmd "${command}"
+}
+
+function run_cmd() {
+  eval "$@"
+}
+
+function updateFile(){
+  rm -f $1
+  if [ $# -eq 1 ]; then
+    while IFS= read -r data; do echo "$data" >> $1 ; done;
+  else
+    echo $2 > $1
+  fi
+
+  p "cat $1"
+  rougify --theme tulip $1
+  
+  doSleep 1
+}
+
+function clearConsole(){
+  echo clear 
+}
+
+function doSleep(){
+  echo sleep $1
+}

gifs/generate_gifs.sh

@@ -12,21 +12,23 @@ test -f $OUT/failures.txt && rm $OUT/failures.txt
 
 docker build gifs --tag gif-renderer  
 docker build gifs/svg_render/ --tag svg_rendrer
+tty && TTY_OPS="-it"
 
 for name in "$@"
 do
   echo processing $name
   svg_render_mappings="-v $SCRIPT_DIR/../website/static/img:/data -v $OUT/.scala:/out"
   svg_render_ops="--in /out/$name.cast --width 70 --height 20 --term iterm2 --padding 20"
-  echo "start" 
+  echo "start with $TTY_OPS" 
 
-  # generate termnail session
-  docker run --rm -it -v  $OUT/.scala:/data/out gif-renderer ./run_scenario.sh  $name || (
+  # Run the scenario
+  docker run --rm $TTY_OPS -v  $OUT/.scala:/data/out gif-renderer ./run_scenario.sh  $name || (
     echo "Scenario failed: $name" &&
     echo $name >> $OUT/failures.txt
   )
-  # render svgs
-  if [ -z "$SKIP_RENDER" ]; then
+
+  # do not render gifs without TTY
+  if [ -n "$TTY_OPS" ]; then
     docker run --rm $svg_render_mappings svg_rendrer a $svg_render_ops --out /data/$name.svg --profile "/profiles/light"
     docker run --rm $svg_render_mappings svg_rendrer a $svg_render_ops --out /data/dark/$name.svg --profile "/profiles/dark"
   fi

gifs/run_scenario.sh

@@ -23,7 +23,16 @@ echo "Done with $?"
 test -f status.txt && rm status.txt
 
 #do recording
-asciinema rec --overwrite --command="$script -n" $SCRIPT_DIR/out/$name.cast
+tty &&
+  # do recording with tty
+  asciinema rec --overwrite --command="$script -n" $SCRIPT_DIR/out/$name.cast ||
+  # without just run the command 
+  ( 
+    export ASCIINEMA_REC=true &&
+    # remove magic from demo...
+    cp $SCRIPT_DIR/demo-no-magic.sh $SCRIPT_DIR/demo-magic.sh &&
+    $script -n
+  )
 
 test -f status.txt || (
   echo "Scenarion $sctip failed." &&

gifs/scenarios/complete-install.sh

@@ -15,22 +15,22 @@ if [[ -z "${ASCIINEMA_REC}" ]]; then
 else
   . $SCRIPT_DIR/../demo-magic.sh
   # # hide the evidence
-  clear
+  clearConsole
 
   # Put your stuff here
   p scala-cli
   scala-cli
   p java
   java
 
-  sleep 2
+  doSleep 2
 
   pe "curl -sSLf https://virtuslab.github.io/scala-cli-packages/scala-setup.sh | sh"
   pe 'source ~/.profile'
   pe "echo 'println(\"Hello from scala-cli\")' | scala-cli -"
 
 
   # Wait a bit to read output of last command
-  sleep 2
+  doSleep 2
   echo " " && echo "ok" > status.txt
 fi

gifs/scenarios/debug.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -e
+
+########################
+# include the magic
+########################
+
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
+
+if [[ -z "${ASCIINEMA_REC}" ]]; then
+  # Code here will be run before the recording session
+  # Warm up scala-cli
+  # echo "println(1)" | scala-cli -
+  # or do other preparation (e.g. create code)
+  echo OK
+else
+  . $SCRIPT_DIR/../demo-magic.sh
+  # hide the evidence
+  clearConsole
+
+  # Put your stuff here
+  # pe "echo 'println(\"<description>\")' | scala-cli -"
+
+  # Wait a bit to read output of last command
+  # doSleep 2
+  echo " " && echo "ok" > status.txt && echo "ok" > status.txt
+fi

gifs/scenarios/defaults.sh

@@ -16,18 +16,18 @@ if [[ -z "${ASCIINEMA_REC}" ]]; then
 else
   . $SCRIPT_DIR/../demo-magic.sh
   # # hide the evidence
-  clear
+  clearConsole
 
   # Put your stuff here
     cat <<EOF | updateFile Main.scala
 @main def hello() = {println("Hello "+"world")}
 EOF
-  sleep 2
+  doSleep 2
   pe 'scala-cli .'
   pe 'scala-cli fmt .'
   p "cat Main.scala"
   rougify --theme tulip Main.scala
   pe 'scala-cli package .'
-  sleep 4
+  doSleep 4
   echo " " && echo "ok" > status.txt
 fi

gifs/scenarios/demo.sh

@@ -20,7 +20,7 @@ EOF
 else
   . $SCRIPT_DIR/../demo-magic.sh
   # # hide the evidence
-  clear
+  clearConsoleConsole
 
   cat <<EOF | updateFile demo.scala
 @main def demo(args: String *) = 
@@ -29,9 +29,9 @@ EOF
 
   pe "scala-cli compile demo.scala" || true
 
-  sleep 5
+  doSleep 5
 
-  clear
+  clearConsoleConsole
 
   cat <<EOF | updateFile demo.scala
 def niceArgs(args: String*): String = 
@@ -40,11 +40,11 @@ def niceArgs(args: String*): String =
 @main def demo(args: String*) = println(niceArgs(args*))
 EOF
 
-  pe "scala-cli demo.scala -- Ala jake Mike"
+  pe "scala-cli demo.scala -- Ala jake Mike" || echo "FAILED!"
 
-  sleep 5
+  doSleep 5
 
-  clear
+  clearConsoleConsole
 
   cat <<EOF | updateFile demo.test.scala
 // using lib "org.scalameta::munit:0.7.29"
@@ -62,6 +62,6 @@ EOF
   pe "scala-cli test demo.scala demo.test.scala" || true
 
   # Wait a bit to read output of last command
-  sleep 5
+  doSleep 5
   echo " " && echo "ok" > status.txt
 fi

gifs/scenarios/education.sh

@@ -15,7 +15,7 @@ if [[ -z "${ASCIINEMA_REC}" ]]; then
 else
   . $SCRIPT_DIR/../demo-magic.sh
   # # hide the evidence
-  clear
+  clearConsole
 
     cat <<EOF | updateFile HelloWorld.scala
 object HelloWorld {
@@ -29,14 +29,14 @@ EOF
   pe "scala-cli HelloWorld.scala"
 
   # Wait a bit to read output of last command
-  sleep 5
-  clear 
+  doSleep 5
+  clearConsole 
       cat <<EOF | updateFile HelloWorld.sc
 println("Hello world from script")
 EOF
 
   pe "scala-cli HelloWorld.sc"
 
-  sleep 5
+  doSleep 5
   echo " " && echo "ok" > status.txt
 fi