add stack.sh; better links to adminer; better shell in worker; use prod sf by default; fix DatabaseSchemaManager.php

Author: Gaetano Giunta

README.md

@@ -37,14 +37,18 @@ In the meantime, you can try out http://sqlfiddle.com/
 
 * Docker-compose: version 1.10 or later
 
+* Recommended: bash shell
+
 * minimum RAM, CPU, Disk space: these have not been measured, but you probably want something better than a raspberry pi...
 
 
 ## Quick Start
 
+NB: if you have no bash shell interpreter on your host computer, scroll to the end for alternative instructions
+
 ### Installation
 
-    cd docker && touch containers.env.local && docker-compose build
+    ./bin/stack.sh build
 
 *NB*: this will take a _long_time. Also, a fast, unmetered internet connection will help.
 
@@ -59,39 +63,34 @@ the host computer, please change variables COMPOSE_WEB_LISTEN_PORT_HTTP and COMP
 
 Example: executing the sql snippet `select current_date` in parallel on all databases:
 
-    cd docker && docker-compose up -d
-    docker exec -ti db3v4l_worker su - db3v4l
-        cd app
-
-        php bin/console db3v4l:sql:execute --sql='select current_date'
-
-        exit
-    docker-compose stop
+    ./bin/stack.sh start
+    ./bin/stack.sh console db3v4l:sql:execute --sql='select current_date'
+    ./bin/stack.sh stop
 
 If you have a bigger set of SQL commands to execute than it is practical to put in a command-line, you can save them
 to a file and then execute it in parallel on all databases:
 
-        php bin/console db3v4l:sql:execute --file=./shared/my_huge_script.sql
+    ./bin/stack.sh console db3v4l:sql:execute --file=./shared/my_huge_script.sql
 
 *NB* to share files between the host computer and the container, put them in the `shared` folder.
 
 *NB* you can also execute different sql commands based on database type by saving them to separate files. The `sql:execute`
 command does replace some tokens in the values of the `--file` option. Eg:
 
-    php bin/console db3v4l:sql:execute --file='./shared/test_{dbtype}.sql'
+    ./bin/stack.sh console db3v4l:sql:execute --file='./shared/test_{dbtype}.sql'
 
-   will look for files `test_mariadb.sql`, `test_mssql.sql`, `test_mysql.sql`, `test_postgresql.sql`, `test_sqlite.sql`
+will look for files `test_mariadb.sql`, `test_mssql.sql`, `test_mysql.sql`, `test_postgresql.sql`, `test_sqlite.sql`
 
-From within the worker container, you can also list all available database instances:
+You can also list all available database instances:
 
-        php bin/console db3v4l:instance:list
+    ./bin/stack.sh console db3v4l:instance:list
 
 As well as test connecting to them using the standard clients:
 
-        mysql -h mysql_5_5 -u 3v4l -p -e 'select current_date'
-        psql -h postgresql_9_4 -U postgres -c 'select current_date'
-        sqlcmd -S mssqlserver_2019_ga -U sa -Q "select GETDATE() as 'current_date'"
-        sqlite3 /home/db3v4l/data/sqlite/3.27/3v4l.sqlite 'select current_date'
+    ./bin/stack.sh run mysql -h mysql_5_5 -u 3v4l -p -e 'select current_date'
+    ./bin/stack.sh run psql -h postgresql_9_4 -U postgres -c 'select current_date'
+    ./bin/stack.sh run sqlcmd -S mssqlserver_2019_ga -U sa -Q "select GETDATE() as 'current_date'"
+    ./bin/stack.sh run sqlite3 /home/db3v4l/data/sqlite/3.27/3v4l.sqlite 'select current_date'
 
 The default password for those commands is '3v4l' for all databases except ms sql server, for which it is 3v4l3V4L.
 
@@ -101,9 +100,9 @@ your browser is executing).
 
 Last but not least, you have access to other command-line tools which can be useful in troubleshooting SQL queries:
 
-        ./vendor/bin/highlight-query
-        ./vendor/bin/lint-query
-        ./vendor/bin/tokenize-query
+    ./vendor/bin/highlight-query
+    ./vendor/bin/lint-query
+    ./vendor/bin/tokenize-query
 
 
 ## Details
@@ -155,6 +154,18 @@ After starting the containers via `docker-compose up -d`, you can:
   such as passwords
 
 
+## Alternative commands to stack.sh
+
+    ./bin/stack.sh build => cd docker && touch containers.env.local && docker-compose build
+    ./bin/stack.sh start => cd docker && docker-compose up -d
+    ./bin/stack.sh shell => docker exec -ti db3v4l_worker su - db3v4l
+    ./bin/stack.sh stop  => cd docker && docker-compose stop
+
+    ./bin/stack.sh console ... =>
+        docker exec -ti db3v4l_worker su - db3v4l
+        php bin/console ...
+
+
 ## Thanks
 
 Many thanks to

app/.bash_profile

@@ -0,0 +1,16 @@
+## CUSTOM environment configuration - added into the container by Docker build
+
+# This file is executed for login shells.
+# Note: we force login shells when using builder.php both for entering the container and for executing scripts
+
+# 1. execute .bashrc stuff for shells which are both login & interactive
+# (note that the debian .bashrc will exit immediately if non-interactive shell is found)
+if [ -f ~/.bashrc ]; then
+   source ~/.bashrc
+fi
+
+# If running interactively, don't do anything more - .bashrc has done everything
+case $- in
+    *i*) return;;
+      *) ;;
+esac

app/.env

@@ -15,7 +15,7 @@
 
 ###> symfony/framework-bundle ###
 KERNEL_CLASS='Db3v4l\Kernel'
-APP_ENV=dev
+APP_ENV=prod
 APP_SECRET=74640ad5ec7f157b08ea25409c99f2e3
 #TRUSTED_PROXIES=127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
 #TRUSTED_HOSTS='^localhost|example\.com$'

app/admin/adminer/plugins/login-servers-enhanced.php

@@ -21,7 +21,7 @@ class AdminerLoginServersEnhanced
     private $servers;
 
     /** Set supported servers
-     * @param array array(AdminerLoginServerEnhanced)
+     * @param AdminerLoginServerEnhanced[] $servers
      */
     public function __construct($servers)
     {
@@ -60,6 +60,21 @@ public function loginForm()
 
     private function getTrServer()
     {
+        // the urls with these params are generated by adminer. We transform them to use $_GET['server']
+        if (isset($_GET["mssql"])) {
+            $_GET['server'] = explode(':', $_GET["mssql"])[0];
+        } elseif (isset($_GET["oracle"])) {
+            $_GET['server'] = explode(':', $_GET["oracle"])[0];
+        } elseif (isset($_GET["pgsql"])) {
+            $_GET['server'] = explode(':', $_GET["pgsql"])[0];
+        } elseif (isset($_GET["server"])) {
+            $_GET['server'] = explode(':', $_GET["server"])[0];
+        } elseif (isset($_GET["sqlite"])) {
+            $_GET['server'] = explode(':', $_GET["sqlite"])[0];
+        } else {
+            $_GET['server'] = null;
+        }
+
         $html = '<tr><th>'.lang('Server').'<td>';
 
         $html .= '<input type="hidden" name="auth[driver]" value="'.$this->servers[0]->driver.'">';
@@ -69,8 +84,8 @@ private function getTrServer()
             if (!$server instanceof AdminerLoginServerEnhanced) {
                 continue;
             }
-            // allow to start with a different db selected based on $_GET['db']
-            $html .= $server->getOptionTag($key == @$_GET['server']);
+            // allow to start with a different db selected based on $_GET['server']
+            $html .= $server->getOptionTag($server->domain == $_GET['server']);
         }
         $html .= '</select>';
 

app/admin/public/index.php

@@ -11,15 +11,18 @@ function buildServerList()
         $servers[$instance] = new AdminerLoginServerEnhanced(
             $def['host'].':'.$def['port'],
             $def['vendor'].' '.$def['version'],
-            str_replace(array('mariadb', 'mysql', 'postgresql'), array('server', 'server', 'pgsql'), $def['vendor'])
+            str_replace(
+                array('mariadb', 'mysql', 'postgresql'),
+                array('server', 'server', 'pgsql'),
+                $def['vendor']
+            )
         );
     }
     return $servers;
 }
 
 function adminer_object()
 {
-
     $pluginsDir = dirname(__DIR__).'/adminer/plugins/';
 
     // required to run any plugin
@@ -36,7 +39,8 @@ function adminer_object()
     );
 
     // customizations
-    class AdminerCustomization extends AdminerPlugin {
+    class AdminerCustomization extends AdminerPlugin
+    {
         function name() {
             // custom name in title and heading
             return 'DB-3v4l Admin';

app/config/secrets/prod/.gitignore

@@ -79,7 +79,7 @@ public function getDropDatabaseQL($userName, $dbName = null)
             $dbName = $userName;
         }
 
-        $dbType = $this->getDbTypeFromDriver($this->databaseConfiguration['driver']);
+        $dbType = $this->getDbType($this->databaseConfiguration);
 
         switch ($dbType) {
             case 'mysql':
@@ -108,7 +108,7 @@ public function getDropDatabaseQL($userName, $dbName = null)
      */
     public function getListDatabasesSQL()
     {
-        $dbType = $this->getDbTypeFromDriver($this->databaseConfiguration['driver']);
+        $dbType = $this->getDbType($this->databaseConfiguration);
 
         switch ($dbType) {
             case 'mysql':

app/src/Core/DatabaseSchemaManager.php

@@ -5,15 +5,15 @@
 {% block page_content %}
     {% embed '@AdminLTE/Widgets/box-widget.html.twig' %}
         {% block box_title %}
-            Welcome to the best command-line SQL shell
+            Welcome to the most promiscuous command-line SQL shell
         {% endblock %}
         {% block box_body %}
             {% apply markdown_to_html %}
             DB-3v4l.org (leetspeak for database-eval) is a command-line tool that allows you to run SQL code on multiple database servers.
 
-            There are currently 19 server instances for you to test against.
+            There are currently 19 server instances for you to test your queries on.
 
-            For every script you submit, this tool gives you back:
+            For every query you submit, this tool gives you back:
             - Output (the selected data)
             - Performance (time and memory) of execution
 
@@ -24,9 +24,8 @@
             ```
             cd docker && docker-compose up -d
             docker exec -ti db3v4l_worker su - db3v4l
-            cd app
 
-            php bin/console db3v4l:sql:execute --sql='select current_date'
+                php bin/console db3v4l:sql:execute --sql='select current_date'
 
             exit
             docker-compose stop

app/templates/Default/index.html.twig

@@ -19,7 +19,7 @@
                 <tbody>
                 {% for instance, config in instances %}
                     {# @todo add prefilling of root username #}
-                    <tr><td>{{ instance }}</td><td>{{ config.vendor }}</td><td>{{ config.version }}</td><td><a href="/admin/?server={{ instance }}" class="fa fa-toolbox"></a></td></tr>
+                    <tr><td>{{ instance }}</td><td>{{ config.vendor }}</td><td>{{ config.version }}</td><td><a href="/admin/?server={% if config.host is defined %}{{ config.host }}{% if config.port is defined  %}:{{ config.port }}{% endif %}{% endif %}" class="fa fa-toolbox"></a></td></tr>
                 {% endfor %}
                 </tbody>
             </table>

app/templates/Instance/list.html.twig

@@ -1,24 +1,9 @@
-- worker: some failures in (temp) db removal are not reported (eg on mysql, for non existing db).
-  Are we leaving behind temp databases?
-
 - improve handling of character sets:
   + make sure we always create utf8 databases
   + make sure we always get back by default utf8 data from the clients
 
-- host: improve cli scripts:
-  + add a 'stack' script that simplifies building the stack and logging into it
-    => force usage of a random (or user-provided) pwd for db root account on startup
-  + also, add a 'console' script to transparently execute sf commands from the host
-  + add a script that removes images+logs+data
-  + move from bash to sh
-
-- set default sf env to prod
-
-- web gui improvements:
-  + keep icons visible when collapsing left menu
-  + add a logo
-
 - admin(er) improvements:
+  + can not connect to mariadb 5.5
   + sqllite not working in pre-filled list of databases (miss filename for root db)
   + add sql log file
   + add data dump capabilities
@@ -30,13 +15,7 @@
   + add a separate sf console that only registers db3v4l commands
   + either remove ./vendor/bin/doctrine-dbal or make it actually work
 
-- worker+web: when listing instances, show the _real_ db version nr. (from a query, not config => ses how Adminer does it)
-
-- worker: improve profile of 'db3v4l' account
-  + esp: add APP_ENV and APP_DEBUG env vars (via bootstrap.sh ?)
-  + start in correct dir automatically
-  + enable `ll` and `la` shell aliases
-  + use a colored shell prompt
+- worker: some failures in (temp) db removal are not reported (eg on mysql, for non existing db)?
 
 - host: allow building/starting partial docker stack for speed and resources (eg. no oracle, no sqlserver, etc...)
   Being able to start a single 'db type' might also make sense in parallelization of tests on travis.
@@ -46,6 +25,20 @@
 
 - add travis testing
 
+- host: improve cli scripts:
+  + stack.sh: force usage of a random (or user-provided) pwd for db root account on startup
+  + add a script that removes docker images and containers (eg. docker-compose down)
+  + move from bash to sh
+
+- web gui improvements:
+  + keep icons visible when collapsing left menu
+  + add a logo
+
+- worker+web: when listing instances, show the _real_ db version nr. (from a query, not config => ses how Adminer does it)
+
+- worker: improve profile of 'db3v4l' account
+  + use a colorful shell prompt
+
 - worker: sanitize sql execution cmd:
   + examine in detail and document the differences between running a command vs a file (eg. transaction usage)
   + disallow execution of commands that are part of the db client instead of being sent to the server, such as eg. 'use db'