trunk/tests/testREST.php

<?php
/**
 * Ce fichier regroupe les tests concernant le REST
 *
 * @package openads
 * @version SVN : $Id$:
 */

// Fichier nécessaire
require_once "../obj/utils.class.php";
require_once "../services/outgoing/MessageSenderRest.class.php";

/**
 * Cette classe permet de faire des tests sur les requêtes REST
 *
 * Données utilisées :
 *
 * Fichiers dans binary_files/test_digitalizedDocument/Transfert_GED
 *
 * Les consultations 1 et 2
 *
 * Le dossier d'autorisation PC0130551200001
 *
 * Le dossier d'instruction PC0130551200001P0
 * 
 */
class RESTTest extends PHPUnit_Framework_TestCase {

    var $base_url = 'http://localhost/openads/';
    
    /**
     * Méthode lancée en début de traitement
     */
    public function setUp() {

        // Instancie la timezone
        date_default_timezone_set('Europe/Paris');
    }

    /**
     * Méthode lancée en fin de traitement
     */
    public function tearDown() {
        
        //
    }

    /**
     * Initialisation pour session cURL
     * @param  string $url        Lien
     * @param  string $request    Mode de requête
     * @param  array $postfields  Données à envoyer
     * @return mixed              Session cURL
     */
    private function init_cURL($url, $request, $postfields) {

        // Initialisation session cURL
        $curl = curl_init();
        // Url de la page à récupérer
        curl_setopt($curl, CURLOPT_URL, $url);
        // Permet de récupérer le résultat au lieu de l'afficher
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        // Démarrer un nouveau cookie de session
        curl_setopt($curl, CURLOPT_COOKIESESSION, true);
        // Requête REST à envoyer (par défaut à GET)
        switch ($request) {
            case 'POST':
                curl_setopt($curl, CURLOPT_POST, true);
                break;
            case 'PUT':
                curl_setopt($curl, CURLOPT_PUT, true);
                break;
        }
        
        // Si il y a des paramètres à envoyer
        if ($postfields != '') {

            // Informations à envoyer
            $postfields = $this->preparePostFields($curl, $postfields, $request);
        }

        // Retour de la session cURL
        $return = curl_exec($curl);
        // Ferme la session cURL
        curl_close($curl);

        // Message retourné par REST
        $message = $this->getReturnMessage($return, $request);

        // Retourne le message
        return $message;
    }

    /**
     * Prépare les paramètres à envoyer en cURL
     * @param  mixed  $curl     Session cURL
     * @param  array  $array    Tableau des paramètres
     * @param  string $request  Méthode utilisée (POST/PUT)
     */
    private function preparePostFields($curl, $array, $request) {
        
        // Si c'est une requête POST
        if ($request == 'POST') {
            
            // Génère une chaîne de requête en encodage URL
            $return = http_build_query($array);

            // Données passées en POST
            curl_setopt($curl, CURLOPT_POSTFIELDS, $return);

        // Sinon c'est une requête PUT
        } else {

            // Encode le tableau en json
            $return =  json_encode($array);

            // Crée un fichier temporaire
            $putData = tmpfile();
            // Ecrit la chaîne dans le fichier temporaire
            fwrite($putData, $return);
            // Place le curseur au début du fichier
            fseek($putData, 0);
            // Permet de retourner des données binaires
            curl_setopt($curl, CURLOPT_BINARYTRANSFER, true);
            // Le fichier lu par le transfert lors du chargement
            curl_setopt($curl, CURLOPT_INFILE, $putData);
            // Taille du fichier en octet attendue
            curl_setopt($curl, CURLOPT_INFILESIZE, strlen($return));

        }
        
    }

    /**
     * Retourne seulement le message du retour REST
     * @param  string $return Retour du REST
     * @return string         Message du retour
     */
    private function getReturnMessage($return, $request) {

        // Si c'est une requête GET
        if ($request == 'GET') {

            // Retraite la chaîne
            $return = substr($return,1,-1);
            $return = trim($return);
            $return = preg_replace("(\r\n|\n|\r)",'',$return);

            // On retourne directement le return
            return $return;
        }

        // Decode du json et crée un objet
        $return = json_decode($return);

        // Retourne le message du retour REST
        return $return->message;
        
    }

    /**
     * Test le retour d'un numéro d'arrêté
     */
    public function testArretesRetourNumero() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/arretes';
        // Mode de la requête
        $request = 'PUT';
        // Données à envoyer
        $postfields = array(
            'numero_arrete' => '21321654',
            'numero_dossier' => 'AZ0130551200001P0',
            'etat_transaction' => 'true',
            'detail_erreur' => '',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Le numéro d\'arrêté a été mis à jour.');

        //Deuxième jet pour autre message
        
        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Erreur : un numéro d\'arrêté existe déjà pour cette instruction');
    }

    /**
     * Test le module user de maintenance
     */
    public function testMaintenanceUser() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/maintenance';
        // Mode de la requête
        $request = 'POST';
        // Données à envoyer
        $postfields = array(
            'module' => 'user',
            'data' => 'NA',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Synchronisation terminée.');
    }

    /**
     * Test le module consultation de maintenance
     */
    public function testMaintenanceConsultation() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/maintenance';
        // Mode de la requête
        $request = 'POST';
        // Données à envoyer
        $postfields = array(
            'module' => 'consultation',
            'data' => 'NA',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, '2 consultations mise(s) à jour.');

        //Deuxième jet pour autre message
        
        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Aucune mise a jour.');
    }

    /**
     * Test le module instruction de maintenance
     */
    public function testMaintenanceInstruction() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/maintenance';
        // Mode de la requête
        $request = 'POST';
        // Données à envoyer
        $postfields = array(
            'module' => 'instruction',
            'data' => 'NA',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, '1 dossier(s) mis à jour.');
    }

    /**
     * Test le module import de maintenance
     */
    public function testMaintenanceImport() {

        // Création du dossier PC0130551200001.P0 dans le dossier de 
        // numérisation
        mkdir('../trs/numerisation/Todo/PC0130551200001.P0/');
        chmod('../trs/numerisation/Todo/PC0130551200001.P0/', 0777);
        // Récupération du document
        copy('binary_files/20091106AUTPCP.pdf', '../trs/numerisation/Todo/PC0130551200001.P0/20091106AUTPCP.pdf');

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/maintenance';
        // Mode de la requête
        $request = 'POST';
        // Données à  envoyer
        $postfields = array(
            'module' => 'import',
            'data' => array(
                'Todo' => '../trs/numerisation/Todo',
                'Done' => '../trs/numerisation/Done'
            ),
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Tous les documents ont ete traites');

        //Deuxième jet pour autre message
        
        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Aucun document a traiter');
    }

    /**
     * Test le module purge de maintenance
     */
    public function testMaintenancePurge() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/maintenance';
        // Mode de la requête
        $request = 'POST';
        // Données à envoyer
        $postfields = array(
            'module' => 'purge',
            'data' => array(
                'dossier' => '../trs/numerisation/Done',
                'nombre_de_jour' => ''
            ),
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Tous les documents ont ete traites');

        // Supprime les dossiers créent pour les tests testMaintenanceImport()
        // et testMaintenancePurge()
        rmdir('../trs/numerisation/Done/PC0130551200001.P0');
        rmdir('../trs/numerisation/Todo/PC0130551200001.P0');
    }

    public function testMaintenanceDossierAutorisation() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/maintenance';
        // Mode de la requête
        $request = 'POST';
        // Données à envoyer
        $postfields = array(
            'module' => 'update_dossier_autorisation',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, "1 dossier(s) d'autorisation(s) mis à jour.");

        //Deuxième jet pour autre message
        
        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Aucune mise à jour');
    }

    /**
     * Test le retour d'avis d'une consultation sans fichier de consultation
     */
    public function testConsultationSansFichier() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/consultations/1';
        // Mode de la requête
        $request = 'PUT';
        // Données à envoyer
        $postfields = array(
            'date_retour' => '15/01/2013',
            'avis' => 'Favorable',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'L\'avis de la consultation 1 a été pris en compte');

        //Deuxième jet pour autre message
        
        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Un retour d\'avis a déjà été rendu pour la consultation \'1\'.');
    }

    /**
     * Test le retour d'avis d'une consultation avec fichier de consultation
     */
    public function testConsultationAvecFichier() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/consultations/2';
        // Mode de la requête
        $request = 'PUT';
        // Données à envoyer
        $postfields = array(
            'date_retour' => '15/03/2013',
            'avis' => 'Favorable',
            'fichier_base64' => 'JVBERi0xLjQKJcOkw7zDtsOfCjIgM',
            'nom_fichier' => 'plop.pdf',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'L\'avis de la consultation 2 a été pris en compte');

        //Deuxième jet pour autre message
        
        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);
        
        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Un retour d\'avis a déjà été rendu pour la consultation \'2\'.');
    }

    /**
     * Test le retour de message
     */
    public function testMessage() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/messages';
        // Mode de la requête
        $request = 'POST';
        // Données à envoyer
        $postfields = array(
            'type' => 'Mise à jour de complétude ERP ACC',
            'date' => '16/06/2014 14:12',
            'emetteur' => 'John Doe',
            'dossier_instruction' => 'PC0130551200001P0',
            'contenu' => array(
                'Complétude ERP ACC' => 'non',
                'Motivation Complétude ERP ACC' => 'Lorem ipsum dolor sit amet...'),
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Insertion du message \'Mise à jour de complétude ERP ACC\' OK.');

        // On change les postfields
        $postfields = array(
            'type' => 'Mise à jour de complétude ERP SECU',
            'date' => '16/06/2014 14:12',
            'emetteur' => 'John Doe',
            'dossier_instruction' => 'PC0130551200001P0',
            'contenu' => array(
                'Complétude ERP SECU' => 'oui',
                'Motivation Complétude ERP SECU' => 'Lorem ipsum dolor sit amet...'),
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Insertion du message \'Mise à jour de complétude ERP SECU\' OK.');

        // On change les postfields
        $postfields = array(
            'type' => 'Mise à jour de qualification',
            'date' => '16/06/2014 14:12',
            'emetteur' => 'John Doe',
            'dossier_instruction' => 'PC0130551200001P0',
            'contenu' => array(
                'Confirmation ERP' => 'oui',
                'Type de dossier ERP' => 'Lorem ipsum dolor sit amet...',
                'Catégorie de dossier ERP' => 'Lorem ipsum dolor sit amet...'),
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Insertion du message \'Mise à jour de qualification\' OK.');

        // On change les postfields
        $postfields = array(
            'type' => 'Dossier à enjeux ERP',
            'date' => '16/06/2014 14:12',
            'emetteur' => 'John Doe',
            'dossier_instruction' => 'PC0130551200001P0',
            'contenu' => array(
                'Dossier à enjeux ERP' => 'oui',),
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Insertion du message \'Dossier à enjeux ERP\' OK.');
        
    }

    /**
     * Test la mise à jour de dossier d'autorisation
     */
    public function testDossierAutorisationMAJERP() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/dossier_autorisations/PC0130551200001';
        // Mode de la requête
        $request = 'PUT';
        // Données à envoyer
        $postfields = array(
            'numero_erp' => '12345',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Numero ERP du batiment etait assigne au dossier d\'autorisation PC0130551200001');
    }

    /**
     * Test l'ERP ouvert
     */
    public function testDossierAutorisationERPOuvert() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/dossier_autorisations/PC0130551200001';
        // Mode de la requête
        $request = 'PUT';
        // Données à envoyer
        $postfields = array(
            'erp_ouvert' => 'oui',
            'date_arrete' => '20/04/2013',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Signature de l\'ouverture ERP au publique etait enregistre pour le dossier d\'autorisation PC0130551200001');
    }

    /**
     * Test l'arrêté d'un dossier DAT effectué
     */
    public function testDossierAutorisationDATArrete() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/dossier_autorisations/PC0130551200001';
        // Mode de la requête
        $request = 'PUT';
        // Données à envoyer
        $postfields = array(
            'arrete_effectue' => 'oui',
            'date_arrete' => '04/06/2014',
        );

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        /// On vérifie le retour de la session cURL
        $this->assertEquals($message, 'Signature de l\'ouverture ERP etait enregistre pour le dossier d\'autorisation PC0130551200001');
    }

    /**
     * Test la méthode GET sur un dossier d'autorisation
     */
    public function testDossierAutorisationGET() {

        // Lien à envoyer
        $url = $this->base_url.'services/rest_entry.php/dossier_autorisations/PC0130551200001';
        // Mode de la requête
        $request = 'GET';
        // Données à envoyer
        $postfields = '';

        // Initialisation cURL
        $message = $this->init_cURL($url, $request, $postfields);

        // On vérifie le retour de la session cURL
        $this->assertEquals($message, '"dossier_autorisation": "PC0130551200001",  "dossier_autorisation_type_detaille": "1",  "exercice": "",  "insee": "01234",  "terrain_references_cadastrales": "",  "terrain_adresse_voie_numero": "",  "terrain_adresse_voie": "",  "terrain_adresse_lieu_dit": "",  "terrain_adresse_localite": "",  "terrain_adresse_code_postal": "",  "terrain_adresse_bp": "",  "terrain_adresse_cedex": "",  "terrain_superficie": "",  "arrondissement": "",  "depot_initial": "",  "erp_numero_batiment": "12345",  "erp_ouvert": "f",  "erp_date_ouverture": "2013-04-20",  "erp_arrete_decision": "f",  "erp_date_arrete_decision": "2014-06-04",  "numero_version": "0",  "etat_dossier_autorisation": "1",  "date_depot": "",  "date_decision": "",  "date_validite": "",  "date_chantier": "",  "date_achevement": "",  "avis_decision": "",  "etat_dernier_dossier_instruction_accepte": "",  "dossier_autorisation_libelle": "PC 013055 12 00001"');
    }

    /*
     * Test de la complétude et la clôture d'un dossier d'instruction
     * ERP -> ADS
     */
    public function testDossierInstructionPut(){
            
        //{{{On essaye de mettre à jour un dossier qui n'existe pas
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/LOREM");
        // Formatage des données à envoyer
        $data = array(
            "message" => "complet",
            "date" => date("d/m/Y")
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Ce dossier n'existe pas"));
        //}}}
        
        //{{{On essaye de mettre à jour un dossier qui existe mais n'est pas un AT
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/PC0130551200001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "complet",
            "date" => date("d/m/Y")
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Ce dossier n'est pas un dossier de type AT"));
        //}}}
        
        //{{{On essaye de mettre à jour un dossier AT en cours d'instruction
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/AT0130551300001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "complet",
            "date" => date("d/m/Y")
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Mise a jour des donnees realisees avec succes"));
        //}}}
        
        //{{{On essaye de mettre à jour un dossier sans message
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/AT0130551300001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "",
            "date" => date("d/m/Y")
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Aucun message fourni"));
        //}}}
        
        //{{{On essaye de mettre à jour un dossier avec un message qui existe pas
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/AT0130551300001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "test",
            "date" => date("d/m/Y")
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Message fourni incorrect"));
        //}}}
        
        //{{{On essaye de mettre à jour un dossier sans date
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/AT0130551300001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "complet",
            "date" => null
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Aucune date fournie"));
        //}}}
        
        //{{{On essaye de mettre à jour un dossier avec une date mal formatée
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/AT0130551300001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "complet",
            "date" => date("m/Y")
        );
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Date fournie au mauvais format"));
        //}}}
        
        //{{{On ne fourni pas de numéro de dossier d'instruction
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/");
        
        // Envoi de la requête 
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Aucun identifiant fourni pour la ressource"));
        //}}}
                
        //{{{On essaye de mettre à jour un dossier AT déjà clos
        // Initialisation de la classe d'envoi de requête REST
        $messageSenderRest = new MessageSenderRest($this->base_url.
            "services/rest_entry.php/dossier_instructions/AT0130551300001P0");
        // Formatage des données à envoyer
        $data = array(
            "message" => "clos",
            "date" => date("d/m/Y")
        );
        
        // Envoi de la requête pour clôturé le dossier
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Mise a jour des donnees realisees avec succes"));
            
        // Envoi de la requête pour tester que l'on ne peut pas clôturer une 
        //seconde fois un dossier d'instruction
        $messageSenderRest->execute("PUT", "application/json", json_encode($data));
        // Vérification de la réponse
        $this->assertEquals($messageSenderRest->getResponse(), 
            _("Ce dossier est deja clos"));
        //}}}
    }
}

?>