Data Cleansing con STK/Unit

L’importanza del Data Cleansing

Un’ovvietà: i dati rappresentano un valore per le aziende.

Un’altra ovvietà: se però non sono corretti sono rappresentano un valore negativo, o almeno “rumore” che distrae dalle informazioni esatte. Sono un valore negativo se spingono il marketing a prendere decisioni sbagliate, sono semplice rumore se le mail di alcuni clienti non sono registrate correttamente.

I motivi per cui un database aziendale può contenere (e contiene) dati parzialmente errati sono molteplici. Vanno dalla pagina di registrazione del sito che accetta come numero di telefono '012345' alla segretaria stanca che ha sbagliato a digitare un nome in un foglio Excel, passando per i bug dei programmi e per i caratteri cirillici gestiti male.

I database, certo, hanno i vincoli di integrità. Ma li hanno se vengono effettivamente usati, ed errori umani permettendo. Parliamo in particolare di MariaDB e MySQL. Fino a poco tempo fa le tabelle erano MyISAM per default, e questa libreria non supporta le chiavi esterne. Del resto le applicazioni open source più diffuse (vuoi per evitare problemi di compatibilità, vuoi per negligenza) se anche usano InnoDB in genere non definiscono le chiavi esterne, tanto meno TRIGGER che mettano al riparo da interventi esterni avventati.

E’ allora indispensabile, per molte aziende, effettuare periodicamente una pulizia dei dati: il Data Cleansing, o Data Cleaning.

Il ruolo di STK/Unit

Per quanto possa sembrare strano, STK/Unit (uno strumento per lo Unit Test di cui ho già parlato in questo blog) è adatto a una prima fase di identificazione degli errori. In effetti uno Unit Testing framework non fa altro che controllare l’esattezza di una serie di unità. Se lo strumento in questione di muove nei database relazionali, può assumere come unità le righe delle tabelle, o insiemi di righe relazionate fra loro. Le asserzioni possono controllare la coerenza di questi dati. Per identificare le righe problematiche, è sufficiente che i messaggi relativi ai Fail contengano il valore della chiave primaria.

Esempio

Supponiamo di avere una tabella customer che contiene i dati dei clienti dell’azienda. Su ognuno di questi dati si potrebbe effettuare almeno un controllo banale (è chiaro che '012345' non è un numero di telefono), ma in questo articolo ci concentreremo sulla Partita IVA. Questa esiste in tutto il mondo sotto il nome anglosassone VAT, ma noi la valideremo secondo le regole specifiche italiane.

Validare una Partita IVA

La prima cosa da fare è creare una Stored Function che accetta in input una stringa e restituisce TRUE se si tratta di una partita IVA italiana valida, FALSE se non è valida, NULL se riceve in input NULL (per coerenza con le funzioni builtin di MySQL e MariaDB). E’ molto comodo, per produrre codice più leggibile, avere anche una funzione char_at() che restituisce un singolo carattere preso da una stringa. Servirà, probabilmente, ogni volta che vi troverete a creare una funzione per la validazione dei dati. Naturalmente, anche se dovremmo scrivere queste funzioni, in realtà non lo faremo: le trovate già pronte, qui di seguito :)

CREATE DATABASE IF NOT EXISTS `it_validation`;
USE `it_validation`;
    
DROP FUNCTION IF EXISTS `char_at`;
CREATE FUNCTION char_at(haystack TEXT, num TINYINT SIGNED)
    RETURNS CHAR(1)
    LANGUAGE SQL
    DETERMINISTIC
    NO SQL
    COMMENT 'Return num-th char from haystack. num starts from 1 and can be negative'
BEGIN
    IF haystack IS NULL OR num IS NULL THEN
        RETURN NULL;
    ELSE
        RETURN (SELECT SUBSTRING(haystack FROM num FOR 1));
    END IF;
END;
    
DROP FUNCTION IF EXISTS `is_vat`;
CREATE FUNCTION is_vat(vat CHAR(50))
    RETURNS BOOL
    LANGUAGE SQL
    DETERMINISTIC
    NO SQL
    COMMENT 'Return wether vat is valid italian VAT number, NULL if is NULL, else FALSE'
BEGIN
    -- current character
    DECLARE cur_char    TINYINT UNSIGNED DEFAULT NULL;
    -- input length
    DECLARE vat_len     TINYINT UNSIGNED DEFAULT 1;
	-- pointer to current char
    DECLARE i           TINYINT UNSIGNED DEFAULT 1;
    -- sub-sums of digits from vat
    DECLARE x           TINYINT UNSIGNED DEFAULT 0;  -- sum of odd nums
    DECLARE y           TINYINT UNSIGNED DEFAULT 0;  -- sum of even nums
    DECLARE z           TINYINT UNSIGNED DEFAULT 0;  -- sum of even nums > 4
    -- computed on sub-sums, must be 0
    DECLARE valid       TINYINT UNSIGNED DEFAULT 0;
    
    IF vat IS NULL THEN
        RETURN NULL;
    END IF;
    
    SET vat_len = CHAR_LENGTH(vat);
    
    -- too short?
    IF vat_len  11 THEN
        RETURN FALSE;
    END IF;
    
    -- get sub-sums
    WHILE i  4 THEN
                SET z = z + 1;
            END IF;
        ELSE
            SET x = x + cur_char;
        END IF;
        
        -- increment index
        SET i = i + 1;
    END WHILE;
    
    -- check digit
    SET valid = 10 - ((x + (y * 2) + z) MOD 10) MOD 10;
    -- if check digit is 10, treat as 0
    RETURN (IF(valid = 10, 0, valid) = CAST(`it_validation`.char_at(vat, 11) AS UNSIGNED INTEGER));
END;

Testiamo la validazione…

Il codice va sempre testato, e il codice che trovate su questo blog non fa eccezione. Siccome stiamo parlando di STK/Unit, appare naturale usarlo anche per testare chat_at() e is_vat():

CREATE DATABASE IF NOT EXISTS `test_it_validation`;
USE `test_it_validation`;
    
DROP PROCEDURE IF EXISTS `test_char_at`;
CREATE PROCEDURE test_char_at()
    LANGUAGE SQL
    COMMENT 'Test char_at()'
BEGIN
    DECLARE haystack CHAR(50) DEFAULT 'miles davis';
    CALL `stk_unit`.assert_null(`it_validation`.char_at(NULL, 1),
        'If any arg is NULL, result should be NULL');
    CALL `stk_unit`.assert_null(`it_validation`.char_at(haystack, NULL),
        'If any arg is NULL, result should be NULL');
    CALL `stk_unit`.assert_equals(`it_validation`.char_at(haystack,  0), '',
        'If num = 0, result should be empty string');
    CALL `stk_unit`.assert_equals(`it_validation`.char_at(haystack,  3), 'l',
        'Incorrect char');
    CALL `stk_unit`.assert_equals(`it_validation`.char_at(haystack, -3), 'v',
        'Incorrect char');
END;
    
DROP PROCEDURE IF EXISTS `test_is_vat`;
CREATE PROCEDURE test_is_vat()
    LANGUAGE SQL
BEGIN
    CALL `stk_unit`.assert_null(`it_validation`.is_vat(NULL),
        'If arg is NULL, should return NULL');
    CALL `stk_unit`.assert_false(`it_validation`.is_vat('123'),
        'Code is too short');
    CALL `stk_unit`.assert_false(`it_validation`.is_vat('012345678912'),
        'Code is too long');
    CALL `stk_unit`.assert_false(`it_validation`.is_vat('12345678901'),
        'This code is not valid');
    CALL `stk_unit`.assert_true(`it_validation`.is_vat('05985341006'),
        'This code is valid');
    CALL `stk_unit`.assert_true(`it_validation`.is_vat('02826010163'),
        'This code is valid');
    CALL `stk_unit`.assert_true(`it_validation`.is_vat('01785490408'),
        'This code is valid');
    CALL `stk_unit`.assert_true(`it_validation`.is_vat('07643520567'),
        'This code is valid');
END;

Per eseguire il Test Case e avere la conferma che quelle due funzioni sono buone, ci basta una semplice istruzione:

CALL `stk_unit`.`tc`('test_it_validation');

Pulire i dati!

Dopo tutti questi preamboli, siamo arrivati al nocciolo della questione: la procedura di Data Cleansing. Il concetto è molto semplice: creiamo un Test Case, e al suo interno un Base Test che esegue un ciclo su una tabella; per ogni riga, il test asserisce che la partita IVA è valida:

CREATE DATABASE IF NOT EXISTS `test_gest`;
USE `test_gest`;
    
DROP PROCEDURE IF EXISTS `test_customer_piva`;
CREATE PROCEDURE test_customer_piva()
    LANGUAGE SQL
    COMMENT 'Test an_anagrafiche.piva'
BEGIN
    -- end of results
    DECLARE `eof` BOOLEAN DEFAULT FALSE;
    -- invalid value
    DECLARE `wrong_piva` TEXT DEFAULT NULL;
    -- id of invalid row
    DECLARE `wrong_id` MEDIUMINT UNSIGNED DEFAULT NULL;
    
    -- read table. but if piva is not mandatory,
    -- we want to exlude empty strings and/or NULLs
    DECLARE `crs_piva` CURSOR FOR
        SELECT `id`, `piva`
            FROM `gest`.`customer`
            WHERE `piva` IS NOT NULL AND `piva` > '';
    
    DECLARE CONTINUE HANDLER
        FOR NOT FOUND
        SET `eof` = TRUE;
    
    -- loop on found rows
    OPEN `crs_piva`;
    `lp_piva`:
    LOOP
        FETCH NEXT FROM `crs_piva`
            INTO `wrong_id`, `wrong_piva`;
        
        IF `eof` IS TRUE THEN
            LEAVE `lp_piva`;
        END IF;
        
        -- trigger a pass if piva is valid, or a fail if its invalid.
        -- failure comment is the if of the wrong row, so we'll be
        -- able to identify it
        CALL `stk_unit`.`assert_true`(`it_validation`.`is_vat`(`wrong_piva`), `wrong_id`);
    END LOOP;
    CLOSE `crs_piva`;
END;

Per eseguire questo test:

CALL stk_unit.tc('test_gest');

E adesso?

Supponendo che abbiate creato la tabella customer contenente almeno i campi id e piva, l’abbiate popolata, e abbiate eseguito il test, ora vi trovate davanti un report di questo genere:

Test Case: test_gest
Id: 11
Completed: YES
198 passes, 2 fails, 0 exceptions
 
FAIL: `test_gest`.`test_customer_piva` [1] - 50
FAIL: `test_gest`.`test_customer_piva` [2] - 100

Questo report ci informa che 198 record hanno passato il test, e quindi hanno una partita IVA valida o non hanno affatto una partita IVA; ma 2 record hanno fallito, perché hanno una partita IVA non valida. Le righe problematiche sono quelle con id 50 e 100. La domanda è: ora che lo sappiamo, cosa facciamo?

Questa decisione va presa in base a diversi fattori. Comunque, nei casi più semplici, vogliamo semplicemente eliminare le righe contenenti dati non validi, o impostare a NULL i campi non validi, o stampare una lista di nominativi a cui sono associati dei dati non validi.

Naturalmente nel primo caso ci serve una DELETE, nel secondo caso una UPDATE, e nel terzo caso una SELECT; ma il principio è esattamente lo stesso. Per semplificare al massimo, consideriamo il caso in cui vogliamo eliminare i dati non validi. Come facciamo?

I risultati dei test si trovano nel database `stk_unit`, e precisamente nella tabella `test_results`. Supponendo che nessuno possa aver eseguito un test dopo di noi, per semplificare ulteriormente, possiamo servirci della vista `last_test_results_bad`, che contiene solo i test falliti durante l’esecuzione dell’ultimo Test Case:

SELECT `msg` FROM `stk_unit`.`last_test_results_bad`;

Nel mio caso, ottengo gli id 50 e 100.

Completiamo l’esempio:

DELETE FROM `customer` WHERE `id` IN
    (SELECT `msg` FROM `stk_unit`.`last_test_results_bad`);

Aggiungere una assert

Supponiamo di aver a che fare con diverse aziende, e di voler essere in grado di eseguire simili test con tutti i nostri clienti. Le aziende alle quali offriamo consulenza utilizzano gestionali diversi, perciò non è possibile riciclare il Test Case `test_gest`. Però possiamo generalizzare una parte del codice che abbiamo scritto, aggiungendo una procedura assert. La useremo al posto di stk_unit.assert_true(), e si chiamerà stk_unit.assert_is_it_vat(). Genererà un Pass ogni volta che le viene passata una partita IVA italiana valida, e un Fail ogni volta che le verrà passato un dato di altro genere.

Ecco come fare:

DROP PROCEDURE IF EXISTS `assert_is_it_vat`;
CREATE PROCEDURE assert_is_it_vat(IN val TEXT, IN msg CHAR(255))
    LANGUAGE SQL
    COMMENT 'Assert that val is valid italian VAT'
BEGIN
    IF `msg` IS NULL THEN
        SET `msg` = CONCAT('Param 1 expected to be a valid Italian VAT; Received: ', `stk_unit`.`ns_str`(`val`));
    END IF;
    CALL `stk_unit`.`assert`(`it_validation`.`is_vat`(val), `msg`);
END;

Il primo parametro è il valore che ci si aspetta sia una partita IVA valida. Il secondo è il messaggio di errore da registrare nel caso in cui non lo sia. Nell’esempio visto prima, il messaggio di errore era semplicemente l’id della riga contenente dati non validi.

Come prima cosa, impostiamo un messaggio di errore di default, da usare nel caso in cui venga passato NULL. Non è obbligatorio, ma è buona norma farlo nelle procedure assert – anche per coerenza con le assert predefinite di STK/Unit.
Dopo, non facciamo altro che chiamare una procedura assert() di livello più basso, che non dovrebbe mai essere chiamata direttamente dai Test Case. Le passiamo il risultato della validazione (ottenuto chiamando it_validation.is_vat()) e il messaggio di errore (che potrebbe essere quello di default).
Questo è sufficiente per avere a disposizione una nuova assert, che si può usare esattamente come prima abbiamo usato assert_true().

Si può inserire questa procedura in qualsiasi database, ma è meglio evitare di inserirla nel database stk_unit per evitare possibili conflitti nelle versioni future. Meglio invece creare un database che funge la libreria personalizzata di assert. Chi facesse questo, è fortemente incoraggiato a contattarmi per condividere le sue librerie!

Divertitevi!

Rilasciato STK/Unit 1.0 Release Candidate 3

2013-04-05

STK/Unit 1.0 Release Candidate 3 è stato rilasciato!

STK/Unit 1.0 Release Candidate 3 dovrebbe essere una versione stabile. L’autore originale di STK/Unit utilizza questo strumento dal 2010, ma lo ha modificato pesantemente quando ha deciso di renderlo pubblico.Tutti i vecchi test che ha creato funzionano ancora.

Dalla prima versione pubblica, rc1, abbiamo ricevuto solo feedback privati. Questi hanno un grande valore, perché ci hanno aiutato a identificare bug e difetti. Tuttavia speriamo vivamente di ricevere dei feedback pubblici, prima di dichiarare STK/Unit production-ready.

Questa RC non è stata pianificata. Tuttiavia, siamo riusciti ad allungare la lista delle versioni supportate di MySQL e MariaDB pur mantenendo un delta molto stretto rispetto alla precedente release. Questo dovrebbe aiutarci a ricevere qualche feedback dagli utenti, e al tempo stesso crediamo di non aver introdotto alcun bug.

Ora, le piattaforme supportate sono:

  • MariaDB 10.0, 5.5
  • MariaDB 5.1, 5.2, 5.3 (con alcuni problemi documentati: alcune funzioni assert riguardanti il DDL potrebbero generare eccezioni misteriose)
  • MySQL 5.6, 5.5
  • MySQL 5.1 (stessi problemi di MariaDB 5.1)

Ecco l’elenco delle modifiche presenti nella versione 1.0 Release Candidate 3:

  • Corretto bug #1162515 (test_stk_unit abortisce su MySQL 5.5)
  • Non è più necessario modificare i file SQL prima dell’installazione su Oracle
  • I BT commentati in test_stk_unit_assertions contenevano degli errori
  • Pulizie minori nel codice

La documentazione e i download di STK/Unit e degli altri strumenti STK che verranno in futuro, sono disponibili qui:
http://stk.wikidot.com/

La Mailing List pubblica si trova qui:
https://launchpad.net/~stk-discuss

Il team di STK vi incoraggia a provare STK/Unit nei vostri database, segnalare qualsiasi bug doveste trovare, chiedere aiuto nella mailing list se necessario, e farci avere i vostri commenti. Il vostro feedback ha un grande valore per noi!

The STK Team

Gli identificatori di MySQL e MariaDB

English version

Gli identificatori di MySQL/MariaDB sono i nomi dei database, delle tabelle, delle colonne, etc. Questi nomi possono essere virgolettati con i `backtick` (AKA backquote), e in questo caso possono contenere dei caratteri che normalmente non sono permessi in un identificatore (perfino il backtick stesso), oppure possono essere parole riservate. Sia il virgolettare i nomi, sia il non farlo, possono causare qualche piccolo problema.

Se si sceglie di non virgolettarli, bisogna evitare di utilizzare caratteri strani e parole riservate (il che comunque è una buona cosa). Ma quando si aggiorna MariaDB, nella nuova versione alcune parole che prima erano permesse potrebbero essere riservate.

Se si virgolettano i nomi, bisogna essere sicuri di farlo dappertutto. E’ anche questa una buona abitudine, ma se uno sviluppatore non usa i backtick (o dimentica di farlo), potrebbe vedere strani errori.

Se si utilizzano parole chiave non virgolettate come identificatori, in genere si riceve un errore 1064 (SQLSTATE 42000):

mysql> SELECT * FROM insert;
ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'insert' at line 1

L’identificatore non permesso generalmente è la prima parola della porzione di codice riportata nell’errore (vedi esempio sopra), ma può anche essere l’ultima parola prima dell’inizio di essa:

mysql> SELECT high_priority FROM t;
ERROR 1064 (42000): You have an error in your SQL syntax; check the manual thatcorresponds to your MySQL server version for the right syntax to use near 'FROM t' at line 1

In teoria, una query che contiene parole riservate non virgolettate usate come identificatori, potrebbe addirittura fare qualcosa di diverso da ciò che il programmatore pensa, e non restituire errori.

Altro avvertimento: anche se si virgolettano tutti gli identificatori, è meglio evitare di utilizzare lo stesso nome per una colonna e per una variabile in una Stored Routine. Anche se MariaDB comprende clausole come: WHERE `id` = `id`, queste possono confondere gli esseri umani che le leggono.

Qualche tool in SQL

Seguono due Stored Routine che potrebbero risultare utili. Per entrambe, riporto anche un Base Test per STK/Unit. Le Stored Routine devono trovarsi in un DB chiamato lib, mentre i BT vanno in un Test Case chiamato test_lib.

La prima funzione virgoletta un identificatore in modo che questo possa essere incluso in una stringa SQL (che potrà poi essere eseguita come Prepared Statement). E’ simile alla funzione builtin QUOTE(), che però serve con le stringhe da usare come valori.

CREATE FUNCTION `lib`.`quote_name`(`id` TEXT)
    RETURNS TEXT
    DETERMINISTIC
    NO SQL
    LANGUAGE SQL
    COMMENT 'Return a quoted identifier (if NULL, id is empty)'
BEGIN
    IF `id` IS NULL THEN
        RETURN '``';
    ELSE
        RETURN CONCAT('`', REPLACE(`id`, '`', '``'), '`');
    END IF;
END;
 
CREATE PROCEDURE `test_lib`.`test_quote_name`()
    LANGUAGE SQL
    COMMENT 'Test quote_name()'
BEGIN
    CALL `stk_unit`.`assert_equals`(`lib`.`quote_name`('x'), '`x`', 'Incorrect quoting');
    CALL `stk_unit`.`assert_equals`(`lib`.`quote_name`('x`y'), '`x``y`', 'Incorrect escape');
 
    CALL `stk_unit`.`assert_equals`(`lib`.`quote_name`(''), '``', 'Empty name expected');
    CALL `stk_unit`.`assert_equals`(`lib`.`quote_name`(NULL), '``', 'For NULL value, empty name should be returned');
END;

Se si vuole validare un nome al volo, probabilmente il modo più rapido è:
SELECT 0 AS [nome];
La seguente procedura però può essere utilizzata all’interno degli Stored Program. E’ possibile usarla per sapere se un certo nome è valido o meno. Esegue la query riportata sopra (come Prepared Statement, perché deve comporla dinamicamente) e controlla se si verifica un errore.

CREATE PROCEDURE `lib`.`is_valid_name`(IN `id` TEXT, OUT `ret` BOOL)
    NO SQL
    LANGUAGE SQL
    COMMENT 'set `ret` to TRUE if id is valid name, else FALSE'
BEGIN
    -- error in query
    DECLARE EXIT HANDLER
        FOR 1064
    BEGIN
        SET `ret` = FALSE;
    END;
 
    SET @sql_query = CONCAT('DO (SELECT 0 AS ', `id`, ');');
    PREPARE stmt FROM @sql_query;
    EXECUTE stmt;
    DEALLOCATE PREPARE stmt;
 
    SET `ret` = TRUE;
END;
 
CREATE PROCEDURE `test_lib`.`test_is_valid_name`()
	LANGUAGE SQL
	COMMENT 'Test quote_name()'
BEGIN
    CALL `lib`.`is_valid_name`('valid_name', @r);
    CALL `stk_unit`.`assert_true`(@r, 'Specified name is valid');
 
    CALL`lib`.`is_valid_name`('SELECT', @r);
    CALL `stk_unit`.`assert_false`(@r, 'SELECT is a keyword');
    CALL `lib`.`is_valid_name`('a a', @r);
    CALL `stk_unit`.`assert_false`(@r, 'Valid names cant contain spaces');
    CALL `lib`.`is_valid_name`('', @r);
    CALL `stk_unit`.`assert_false`(@r, 'Empty name is not valid');
END;

Rilasciato STK/Unit 1.0 Release Candidate 1

English announcement

E’ uscito STK/Unit 1.0 Release Candidate 1!

STK sta per SQL ToolKit. Si tratta di una famiglia di progetti per MariaDB, MySQL e Percona Server. STK/Unit è il primo progetto STK a essere rilasciato pubblicamente; altri arriveranno nel prossimo futuro. L’obiettivo di STK nel lungo termine è rendere la programmazione SQL molto più semplice ed affidabile su MariaDB e le sue sorelle.

STK/Unit è una piattaforma di Unit Test per MariaDB, interamente scritta in SQL e ispirata da SimpleTest e JUnit. I Test Case e le Test Suite scritti dall’utente possono creare un ambiente di test e verificare che tutte le operazioni producano i risultati previsti. I risultati possono essere estratti come stringa leggibile, in formato HTML, o esaminati nelle tabelle nelle quali vengono scritti. Tanto gli sviluppatori quanto gli amministratori di database possono trarre beneficio da STK/Unit.

Gli errori che si verificano nelle applicazioni possono avere origine nei database. STK/Unit è progettato principalmente per testare le strutture SQL attive: Stored Routine, Trigger, vincoli di integrità e Viste. Ma anche le tabelle devono servirsi dei tipi di dati, dimensioni delle colonne e set di caratteri adatti a contenere i dati che arrivano dal Mondo Reale. Inoltre gli aggiornamenti del DBMS, i nuovi plugin e perfino i cambiamenti nella configurazione possono portare anomalie nelle complesse e delicate logiche dei database relazionali. Ma un buon set di test può far emergere i problemi appena questi si verificano!

STK/Unit è ancora in sviluppo e sta espandendo il parco di piattaforme supportate; attualmente, funziona sulle seguenti:
* MariaDB 5.5 e 10.0 – funziona bene
* MariaDB 5.3, 5.2, 5.1 – con problemi minori, documentati
* MySQL 5.1 – utilizzando MyISAM invece di Aria, con problemi minori (non documentati al momento)

La Documentazione e i Download di STK/Unit e degli altri strumenti STK che verranno sono reperibili qui:
http://stk.wikidot.com/

La Mailing List pubblica si trova qui:
https://launchpad.net/~stk-discuss

Il team di STK incoraggia tutti a provare STK/Unit nei propri database, segnalare qualsiasi bug venga riscontrato, chiedere aiuto in lista se necessario, e farci avere i vostri commenti. I vostri feedback hanno un grande valore per noi!

Il team di STK