docs

Author: Gaetano Giunta

TODO.md

@@ -1,16 +1,10 @@
-- 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 
-
 - worker: improve sql execution cmd:
   + allow it to pick an existing db/user
-  + disallow execution of commands that are part of the db client instead of being sent to the server, such as eg. 'use db'
-    - ok for mysql? (to be tested)
-    - missing for psql? (according to slack discussion: this is impossible using psql and can only be done using a different
-      driver... it might be in fact already happening when NOT using input via files...)
-    - missing for sqlsrv
   + examine in detail and document the differences between running a command vs a file (eg. transaction usage)
-  + check: can the temp user drop&creates other databases for postgresql?
+
+- 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 
 
 - improve cli scripts:
   + add a 'stack' script that simplifies building the stack and logging into it
@@ -26,7 +20,19 @@
 
 - add travis testing
 
-- worker: improve profile of 'db3v4l' account (esp: add APP_ENV and APP_DEBUG env vars; start in correct dir automatically)
+- worker: sanitize sql execution cmd:
+  + disallow execution of commands that are part of the db client instead of being sent to the server, such as eg. 'use db'
+    - ok for mysql? (to be tested)
+    - missing for psql? (according to slack discussion: this is impossible using psql and can only be done using a different
+      driver... it might be in fact already happening when NOT using input via files...)
+    - missing for sqlsrv
+  + check: can the temp user drop&creates other databases for postgresql?
+
+- worker: improve profile of 'db3v4l' account
+  + esp: add APP_ENV and APP_DEBUG env vars
+  + start in correct dir automatically
+  + enable `ll` and `la` shell aliases
+  + use a colored shell prompt
 
 - worker+web: add a queued-task implementation, using sf messenger and a db
 

WHATSNEW.md

@@ -3,11 +3,10 @@ Version 0.6
 
 - New: added SQLite 3.27
 
-- Improved: sort database names when listing them (except for MySQL and MariaDB)
-
 - Fixed: the number of total failures was not computed correctly when executing SQL if the failure was in the creation
    of the temporary database 
 
+- Improved: sort database names when listing them (except for MySQL and MariaDB)
 
 Version 0.5
 -----------

app/src/Command/DatabaseCreate.php

@@ -16,7 +16,7 @@ protected function configure()
         $this
             ->setDescription('Creates a user+database in parallel on all configured database instances')
             ->addOption('user', null, InputOption::VALUE_REQUIRED, 'The name of the user to create')
-            ->addOption('password', null, InputOption::VALUE_REQUIRED, 'The password')
+            ->addOption('password', null, InputOption::VALUE_REQUIRED, 'The password. If omitted, a random one will be generated and echoed to stderr')
             ->addOption('database', null, InputOption::VALUE_REQUIRED, 'The name of the database. If omitted, the user name will be used as database name')
             ->addCommonOptions()
         ;
@@ -54,9 +54,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
             throw new \Exception("Please provide a username");
         }
 
-        /// @todo warn the user...
         if ($password == null) {
             $password = bin2hex(random_bytes(16));
+
+            // Should we warn the user always? To avoid breaking non-text-format, we can send it to stderr...
+            // Otoh we give the password in the structured output that we produce
+            //$this->writeErrorln("<info>Assigned password to the user: $password</info>");
         }
 
         // On Debian, which we use by default, SF has troubles understanding that php was compiled with --enable-sigchild