dbquery TU Delft Bachelorproject IN3405 Verslag Auteur: Rutger PLAK (# ) Opdrachtgever: Larry POORT, Anan6 BV

Transcriptie

1 TU Delft Bachelorproject IN3405 dbquery Verslag Auteur: Rutger PLAK (# ) Opdrachtgever: Larry POORT, Anan6 BV Supervisor: Gerd GROSS Faculteit: EWI August 17, 2012

2

3 Voorwoord Om een bachelor Technische Informatica aan de Technische Universiteit van Delft af te ronden is het in de laatste fase van de opleiding verplicht een project te doen in de vorm van een stage bij een bedrijf of op de universiteit. Dit project heet het Bachelorproject en geldt voor 15 ECTS. Deze stage is uitgevoerd bij Anan6 BV te s Gravenhage in opdracht van eigenaar van Anan6 en tevens interne begeleider Larry Poort. Ik wil hem graag bedanken voor zijn hulp in de vorm van aanbevelingen en ervaringsgericht advies. Ook wil ik hem bedanken voor de ervaring die ik heb mogen opdoen tijdens deze stage. De heer Gerd Gross is tijdens deze stage de stagebegeleider namens de Technische Universiteit Delft geweest. Ook meneer Gross wil ik graag bedanken voor het mogelijk maken van deze stage. 1

4

5 Contents Voorwoord 1 Definities 7 I Eindproduct 8 1 Inleiding 9 2 Eindproduct Productomschrijving Objectives Het uit handen nemen van PHP programmatuur van de javascript programmeur Het uit handen nemen van MySQL programmatuur van de javascript programmeur Het uit handen nemen van het maken van klasses (functies) per tabel in javascript van de javascript programmeur Het minimaliseren van netwerkverkeer Functionaliteit Gebreken Toekomst en aanbevelingen Vooronderzoek Plan van aanpak Userstories Requirements Analysis Architectural Design Test and Implementation plan Procesverslag /07/ /07/ /07/ /07/ /07/ /07/ /07/ /07/ /07/ /08/ /08/ /08/ /08/ /08/

6 IN Bachelorproject - dbquery CONTENTS 4.8 Reflectie Documentatie Hoe dbquery werkt Installatie Configuratie db() Voorbeeld Voorbeeld Voorbeeld Voorbeeld dbobject.getattribute() Voorbeeld Voorbeeld dbobject.setattribute() Voorbeeld dbobject.save() Voorbeeld Voorbeeld dbobject.remove() Voorbeeld Voorbeeld Uitgebreid voorbeeld Testen Unit testing PHP Javascript Integration testing Acceptance testing II Vooronderzoek 34 A Plan van aanpak 35 A.1 Voorwoord A.2 Samenvatting A.3 Introductie A.3.1 Aanleiding A.3.2 Accordering en bijstelling A.3.3 Toelichting op de opbouw van het plan A.4 Projectopdracht A.4.1 Projectomgeving A.4.2 Doelstelling project A.4.3 Opdrachtformulering A.4.4 Op te leveren producten en diensten A.4.5 Eisen en beperkingen A.4.6 Voorwaarden

7 IN Bachelorproject - dbquery CONTENTS A.5 Planning B Userstories 39 B.1 Introductie B.2 Globale beschrijving B.3 Userstories Objecten Eigenschappen Opslaan Gebruiksgemak C Requirements Analysis 42 C.1 Introductie C.2 Overzicht C.2.1 Clientside C.2.2 Serverside C.3 Functional requirements C.3.1 Objecten C.3.2 Semantische links C.3.3 Eigenschappen van objecten C.3.4 Opslaan C.3.5 Installatie C.4 Quality requirements C.4.1 Toegankelijkheid C.4.2 Prestaties / Efficientie C.4.3 Onderhoudbaarheid C.4.4 Betrouwbaarheid en beschikbaarheid C.4.5 Security C.4.6 Precisie en accuraatheid C.5 Design requirements C.5.1 Constraint gebaseerd op het type gebruiker C.6 Process requirements C.6.1 Ontwikkelmethode C.6.2 Kosten en opleveringsdatum C.7 Constraints C.8 Analysis models C.8.1 Use case models C.8.2 Dynamische weergave dataverkeer D Architectural Design 52 D.1 Introductie D.1.1 Doel van het systeem D.2 Voorgestelde software architectuur D.2.1 Ontwerppatroon D.2.2 Ontwerpprincipes D.2.3 Systeemcomponenten D.2.4 Subsysteem decompositie D.2.5 Hardware / Software mapping

8 IN Bachelorproject - dbquery CONTENTS D.2.6 Persistent Data Management D.2.7 Global Resource handling en Access Control voor verschillende actoren 58 D.2.8 Randvoorwaarden E Test and Implementation plan 60 E.1 Introductie E.2 Requirements met MoSCoW E.2.1 Must E.2.2 Should E.2.3 Could E.2.4 Won t E.3 Implementatie en tests E.3.1 Volgorde voor het implementeren van de features E.3.2 Documentatie E.3.3 Unit testen E.4 Risico analyse F Afwegingen 64 F.1 Databasesoort F.2 PHP vs. NodeJS F.2.1 PHP F.2.2 NodeJS F.2.3 PHP vs. NodeJS F.2.4 Conclusie F.3 Standaardisatie berichten F.3.1 Server naar client F.3.2 Client naar server F.4 Chaining F.4.1 Introduction F.4.2 Directe chaining F.4.3 Callbacks F.4.4 Combinatie van beide G Voorbeeldcode 71 G.1 NodeJS G.2 PHP Bibliografie 76 6

9 Definities Apache + Webservice die op serverside draait. Backwards Compatibility + Updates van de software zijn altijd te gebruiken met software die de oudere versie gebruikt. Beta versie + Update van software die nog in de testfase is maar wel openbaar wordt gemaakt. Client + Computer die met behulp van bepaalde software (dbquery.js) via een netwerk gebruikt maakt van de software op de server. Clientside + Software aan de kant van de client. Database + Georganiseerde collectie data op de server. Databasecommunicatie + Communicatie met de database. Databasetabel + Tabel in een database die informatie bevat. dbquery + Naam van de te ontwikkelen software. Documentatie + Document waarin alle code van de software staat uitgelegd. Entry + Regel in een databasetabel waarin gegevens staan. Foreign key + Sleutel in een databasetabel waarin een link ligt naar een andere databasetabel. HTML + HyperText Markup Language. Syntax die gebruikt wordt om webbrowsers websites te laten draaien en renderen. Javascript + Programmeertaal die op clientside gedraaid wordt in webbrowsers. json + Door zowel PHP als Javascript te interpreteren manier van informatie coderen. jquery + Javascript library die browser compatibiliteit gemakkelijker maakt. MySQL + Relational Database Management System die draait op serverside. Dit systeem omvat de database en heeft deze database is toegankelijk met een door MySQL gedefinieerde syntax. MySQL-poort + Netwerkpoort die open staat om verkeer binnen te kunnen krijgen voor MySQL. NodeJS + Software waarmee javascript op een server kan draaien. Open-Source + Manier van software uitgeven waarbij de code volledig openbaar is. PHP + Programmeertaal die op serverside gedraaid wordt en aanroepen kan verwerken vanaf de clientside. Pseudocode + Niet werkende nep code die eenvoudig leesbaar is en een goed beeld geeft van de uiteindelijke code. Release versie + Versie van software waarbij alle updates in de nieuwe versie volledig getest zijn. SCRUM + In korte sprints werkende software leveren. Na iedere iteratie blijft de software werken maar worden er nieuwe functionaliteiten toegevoegd. Server + Machine waarnaar via een netwerkverbinding aanroepen naar gedaan kunnen worden. Serverside + Software aan de kant van de server. Sleutel + Identifier van een entry in een database. SVN (Subversion) + Manier van versiebeheer waarbij alle gecommitte wijzigingen (revisions) ongedaan gemaakt kunnen worden. Tabel + Zie databasetabel. Tabelnaam + Naam van een databasetabel. 7

10 Part I Eindproduct 8

11 Chapter 1 Inleiding In de inleiding zal de gedachte achter het project worden uitgewerkt aan de hand van de huidige situatie, de tools die gebruikt worden om een bevredigend eindresultaat te leveren en een globale beschrijving van het eindproduct zelf. De opdrachtgever Anan6 BV ontwerpt, implementeert en onderhoudt webbased software. Deze software wordt gemaakt in het zelfgemaakte Content Management Systeem Anan6 CMS. Het betreft in veel gevallen intranet systemen van bedrijven. Zo heeft Anan6 BV een Bussiness Process Management System (BPMS) dat door vele bedrijven wordt gebruikt. Hierin kunnen bedrijven al hun administratie verwerken, aan de hand van door de bedrijven zelf vastgelegde protocollen en routeformulieren. Het BPMS zorgt ervoor dat alle taken behorende bij een bepaalde klantafhandeling worden uitgevoerd en het BPMS motiveert de gebruikers van het systeem deze handelingen zo snel en efficiënt mogelijk af te handelen. Deze systemen maken bijzonder veel gebruik van databases. De data van alle klanten van de bedrijven staan in databases en moeten worden gebruikt in de systemen. Om deze data te kunnen gebruiken, moet deze worden opgehaald van de server op een zodanige manier dat de informatie bruikbaar is aan de clientside van de software. Anan6 BV wil de manier van informatie vergaren uit een database richting de clientside van de software vereenvoudigen, om tijd te besparen en de code van de systemen meer uniform te maken. Om dit te realiseren wordt dit bacheloreindproject uitgevoerd. In de loop der jaren zijn de systemen van Anan6 BV gestaag gegroeid. De grote en uitgenormaliseerde databases worden elk met aparte software benaderd. Door een javascript plugin te creeëren die de databaseafhandeling voor zijn rekening neemt, worden alle aparte softwareschillen om databasecommunicatie te realiseren overbodig. Belangrijker nog, toekomstige softwareschillen voor databasecommunicatie hoeven niet geschreven te worden. In dit document wordt de onderzoeksfase van het bacheloreindproject uitgewerkt. Aan de hand van deze onderzoeksfase is software ontwikkeld in de implementatiefase. Beide fases zijn uitgebreid gedocumenteerd en vastgelegd in dit document. Er wordt vooraf gepland en achteraf gereflecteerd. Ook zullen toekomstige features die de plugin zouden kunnen verbeteren uitgewerkt. Dit document zal tevens documentatie van de software bevatten. Ook zal geconcludeerd worden in hoeverre de software bruikbaar is en hoe deze open source software voor andere bedrijven bruikbaar kan zijn. 9

12 IN Bachelorproject - dbquery CHAPTER 1. INLEIDING Huidige situatie Wanneer in de huidige situatie informatie nodig is of aan te passen moet zijn, zijn er verschillende softwarecomponenten nodig: Er moet een javascript object worden gemaakt die overeenkomt met de databasestructuur, waar de vergaarde informatie moet worden opgeslagen. Er is een javascript die een call doet naar de server, die de benodige informatie doorgeeft aan de server. Op de server is een script dat luistert naar de javascript call. Op de server wordt in MySQL informatie uit de database opgehaald of aangepast. Door MySQL geretourneerde informatie wordt door PHP op de server verwerkt en teruggestuurd naar de client. Het javascript bestand verwerkt de informatie die geretourneerd wordt door de server. Een programmeur van de systemen van Anan6 BV moet kennis hebben van zowel javascript, PHP als MySQL. Dit terwijl de programmeur de informatie slechts wil gebruiken in Javascript. Zowel PHP als MySQL zijn hierbij talen die slechts nodig zijn om de informatie te vergaren die hij in javascript wil gebruiken. Het wegnemen van PHP en MySQL uit de handen van de javascript programmeur zou tijd en geld schelen voor Anan6 BV. In hoofdstuk 2 wordt het geimplementeerde eindproduct uitgewerkt. Vervolgens zal in hoofdstuk 5 de documentatie van het eindproduct verwerkt zijn. In de Appendix kunnen de verschillende documenten, geschreven in de onderzoeksfase, gevonden worden. 10

13 Chapter 2 Eindproduct In dit hoofdstuk wordt het eindproduct van de opdracht beschreven. Er zal worden uitgewerkt wat het globale idee is achter het eindproduct. Ook wordt uitgewerkt waarom het product de huidige situatie zou verbeteren. Het nut van het eindproduct wordt hierin besproken aan de hand van de verschillen met de huidige situatie. De objectives van het product worden behandeld. Tevens zal worden uitgelegd waar het eindproduct niet zou werken en waar de huidige situatie de huidige versie van het eindproduct nog overtreft. Hierbij zal realistisch ingegaan worden op de gebreken van de huidige versie van het systeem. Ook zal worden uitgewerkt op welke manier het eindproduct in de toekomst kan worden uitgebreid. 2.1 Productomschrijving Het eindproduct zal databasecommunicatie vanuit javascript op de clientside vereenvoudigen. Hierbij zullen objecten aan de hand van hun databasetabelnaam kunnen worden opgehaald uit de database. Om dit te bereiken zal een javascript programmeur slechts een enkele functie hoeven aan te roepen. Hierbij geeft hij aan welke databaseregels er moeten worden opgehaald. Dit kan aan de hand van een identifier of selectiecriteria. Wanneer de javascript programmeur deze objecten heeft aangemaakt, kan hij ze gebruiken als normale objecten. Hij kan hierbij alle eigenschappen die het object in de database bevat opvragen en aanpassen. Wanneer aanpassingen moeten worden opgeslagen in de database, kan de programmeur dit met een eenvoudige functie aanroep doen. Goed uitgenormaliseerde databases bevatten veel foreign keys. Deze sleutels wijzen naar andere tabellen in de database. Op deze manier kan een tabel klant naar een tabel adres linken. Wanneer drie klanten op hetzelfde adres wonen, bevatten zij alle drie een foreign key naar dezelfde regel in de tabel adres. Hierbij wordt redundante informatie gereduceerd. Wanneer een javascript programmeur aan het klantobject het adres opvraagt, wordt een database object van het type adres teruggestuurd. 2.2 Objectives De main objectives van de te implementeren javascript plugin zijn: 1. Het uit handen nemen van PHP programmatuur van de javascript programmeur. 2. Het uit handen nemen van MySQL programmatuur van de javascript programmeur. 11

14 IN Bachelorproject - dbquery CHAPTER 2. EINDPRODUCT 3. Het uit handen nemen van het maken van klasses (functies) per tabel in javascript van de javascript programmeur. 4. Het minimaliseren van netwerkverkeer. Wanneer deze objectives behaald zijn, kan gesproken worden van een succesvol verlopen project. Ieder van deze objectives zijn een zeer wenselijke situatie. De voordelen van het behalen van de objectives wordt in de komende secties uitgewerkt Het uit handen nemen van PHP programmatuur van de javascript programmeur. In de huidige situatie moet een javascript programmeur wanneer hij objecten uit de database wil halen in PHP een door javascript aanspreekbare webservice schrijven. Deze webservice moet vervolgens objecten per tabel gebruiken. Deze objectklassen moeten ook worden geimplementeerd door de programmeur. Vanuit PHP wordt met MySQL gecommuniceerd met de database. De javascript programmeur zal om al deze functionaliteit te implementeren een goede kennis hebben van PHP. Deze kennis moet worden vergaard. Het leren van PHP kost zeer veel tijd. Javascript en PHP zijn functioneel vrij verschillende programmeertalen. De asynchroniteit van javascript en de sequentialiteit van PHP staan lijnrecht tegenover elkaar en vereisen een volledig andere behandeling van functie afhandelingen. Hierdoor kan het voor een programmeur lastig zijn om zowel Javascript als PHP volledig te beheersen. Wanneer het niet nodig is voor een javascript programmeur om PHP te beheersen, kunnen kosten worden bespaard op opleiding en/of training. Ook zou het tijdens de implementatiefase veel tijd kosten om voor iedere databasetabel een aparte PHP klasse te schrijven met een webservice erbij. Deze tijd moet iedere keer opnieuw worden gebruikt. Het wegnemen van deze verplichting scheelt veel tijd en geld Het uit handen nemen van MySQL programmatuur van de javascript programmeur. Vanuit PHP kan worden gecommuniceerd met de databases. Anan6 gebruikt hiervoor MySQL. Het vergaren van informatie uit de database benodigd het uitvoeren van MySQLqueries naar de database. Deze MySQL queries hebben een syntax die is vastgesteld door MySQL. Iedere tabel heeft een andere structuur en zal anders benaderd moeten worden. Per tabel moet een programmeur zich verdiepen in de tabel en per gewenste actie is een andere MySQL querie nodig. De geretourneerde informatie vanuit MySQL moet worden verwerkt in PHP. Door de volledige databasecommunicatie van PHP naar MySQL te automatiseren, hoeft de programmeur geen verstand te hebben van MySQL. De volledige databasestructuur, datatypes, default values e.d. hoeven niet meer tot de kennis van de programmeur te behoren. De structuur van de tabellen staat vastgesteld in interne databasetabellen binnen MySQL. Automatisch uitlezen van deze tabellen kan deze functionaliteit mogelijk maken. Wanneer deze functionaliteit is geimplementeerd, hoeft een javascript programmeur geen verstand meer te hebben van MySQL. Hiermee kan Anan6 BV kosten besparen in het opleiden van werknemers om MySQL te beheersen. Tevens kan de tijd die wordt gebruikt 12

15 IN Bachelorproject - dbquery CHAPTER 2. EINDPRODUCT om MySQL queries te implementeren nu voor andere doeleinden worden gebruikt en kan Anan6 BV hiermee tijd (en geld) besparen Het uit handen nemen van het maken van klasses (functies) per tabel in javascript van de javascript programmeur. Iedere tabel in een database kan gezien worden als een klasse. Iedere regel in deze tabel kan gezien worden als een object van deze klasse. Om informatie uit de database bruikbaar te maken, is het handig om een schil om de databasetabel te maken. Deze schil wordt geimplementeerd in de vorm van een klasse. Deze klassen moeten per tabel worden geimplementeerd. Dit is veel werk, gezien alle functies voor iedere tabel voor iedere kolom opnieuw geimplementeerd moeten worden. Door het aanmaken van deze klassen te automatiseren, kan veel tijd worden bespaard. Dit is mogelijk door de interne MySQL structuur van de tabellen uit te lezen en aan de hand hiervan de eigenschappen van een klasse dynamisch te vullen Het minimaliseren van netwerkverkeer. Wanneer er met een database gecommuniceerd moet worden vanuit een client, moeten er calls vanuit javascript naar de server plaatsvinden. Deze calls sturen informatie over een netwerk naar de server. De server stuurt op zijn beurt informatie terug over het netwerk naar de client. Om netwerkbelasting te minimaliseren moeten deze calls zo min mogelijk worden uitgevoerd. Er zijn op twee momenten netwerkverkeer noodzakelijk: Bij het uitlezen van objecten uit de database. Bij het opslaan van informatie in de database. Door slechts bij deze twee acties een netwerkcall te doen, wordt het netwerk zo min mogelijk belast. Wanneer een set objecten uit de database wordt gehaald, moeten deze in één call worden teruggestuurd. De aangemaakte objecten kunnen globaal worden bewaard aan de clientside. Zij hoeven niet steeds opnieuw ingelezen te worden. 2.3 Functionaliteit Om gebruiksvriendelijk en eenvoudig te werken, moet dbquery zo min mogelijk functies hebben om zoveel mogelijk functionaliteit uit te voeren. De functies die uitgevoerd moeten kunnen worden zijn: Het ophalen van objecten uit de database. Het ophalen van attributen van objecten uit de database. Het aanpassen van attributen van objecten uit de database. Het opslaan van aanpassingen aan objecten in de database. Het verwijderen van objecten uit de database. Het ophalen van een set objecten uit de database met selectiecriteria. Het chainen [F.4] van functies. 13

16 IN Bachelorproject - dbquery CHAPTER 2. EINDPRODUCT Deze functionaliteiten worden bereikt met de volgende functies: db() Haalt (een) object(en) op uit de database aan de hand van tabelnaam en selectiecriteria. db.getattribute( naam ) Haalt attributen op van objecten. db.setattribute( naam, waarde ) Past attributen van objecten aan. db.save() Slaat aanpassingen op in de database. db.remove() Verwijdert object uit de database. Een uitgebreide documentatie van de functies kan gevonden worden in hoofdstuk Gebreken dbquery kan gebruikt worden voor eenvoudige databasecommunicatie. Hierbij kunnen aanpassingen worden gedaan aan tabellen en er kunnen semantisch gelinkte objecten aangeroepen worden die op hun beurt weer als dbobject kunnen worden benaderd en aangepast. Hierbij is een groot gedeelte van functionaliteit van databases gedekt. Echter, er zijn functionaliteiten die dbquery (nog) niet dekt: Uitgebreide selectiecriteria In de huidige versie van dbquery is het mogelijk om objecten uit de database te halen aan de hand van selectiecriteria. Zo kunnen alle klanten met leeftijd 23 uit de database worden gehaald, of alle winkels met soort supermarkt en zondagopen ja. Echter, in de praktijk is het vaak nodig om ingewikkeldere selectiecriteria mee te geven. Bijvoorbeeld alle klanten van 23 tot 25 jaar. Of alle winkels met beschrijving lijkend op markt. Deze uitgebreidere selectiecriteria zijn in de huidige versie van dbquery niet mogelijk. In de huidige versie is het slechts mogelijk om = selectiecriteria mee te geven, gebundeld door en. n op n gelinkte tabellen In de praktijk zijn tabellen vaak n op n gelinkt. Hierdoor bestaat er een extra tabel met twee foreign keys. Het is in de huidige versie van dbquery niet mogelijk om deze objecten op te halen. De n op n semantische links worden niet ondersteund. Ingewikkelde select sets Vaak worden objecten uit een tabel geselecteerd door ingewikkelde selectiecriteria die meerdere tabellen overspannen. Zo kan het zijn dat alle klanten waarvan het adres (andere tabel) nog geen postcode bevat opgevraagd moeten worden. Dit wordt door de huidige versie van dbquery nog niet ondersteund. Waar meerdere tabel overspannende selectiecriteria in direct MySQL in 1 query uitgevoerd kunnen worden, moet nu geïtereerd worden over alle rijen om te controleren of het adres een postcode bevat. 2.5 Toekomst en aanbevelingen In volgende versies van dbquery kunnen uitbereidingen worden gedaan om de huidige gebreken van dbquery te verminderen. De plannen van Anan6 BV zijn om dbquery uit te brengen en verder door te ontwikkelen. Enkele punten waarop dbquery kan worden doorontwikkeld: 14

17 IN Bachelorproject - dbquery CHAPTER 2. EINDPRODUCT Selectiecriteria zijn nu slechts mogelijk met de = operator, gelinkt door en statements. In de toekomst moeten selectiecriteria in plaats van uit twee delen uit drie delen bestaan, zodat de selectie kan worden uitgebreid. Waar nu { leeftijd, 23 } een selectiecriterium is voor leeftijd=23, moet het in de toekomst mogelijk zijn om { leeftijd, <, 23 } mee te geven, zodat alle personen onder de 23 jaar opgehaald worden. Ook moet het mogelijk zijn om text search te doen. Waar nu { soort, supermarkt } alle objecten met soort supermarkt ophaalt, moet het in de toekomst mogelijk zijn om { soort, like, %markt% } mee te geven, zodat ook een winkel met soort marktkraam wordt geselecteerd. In de huidige versie worden callbacks in callbacks uitgevoerd. In de toekomst kunnen deze callbacks samen worden gevoegd tot één callback die pas uitgevoerd wordt als het diepste niveau is geinitialiseerd. Waar nu bij een driedubbel gelinkte getattribute() drie aparte callbacks worden meegegeven, kan door javascript intern te manipuleren deze callbacks worden samengevoegd tot een enkele. Hiervoor is echter veel vooronderzoek nodig dat buiten dit project valt. 15

18 Chapter 3 Vooronderzoek Het te implementeren product is ontwikkeld na een uitgebreide onderzoeksfase. In deze fase zijn verschillende documenten geschreven en is veelvoudig overleg gepleegd. De documenten zijn in overleg met de opdrachtgever en betrokkenen geschreven door de ontwikkelaar. In de appendix zijn de documenten geschreven in het vooronderzoek te vinden. 3.1 Plan van aanpak Het plan van aanpak bevat de globale gang van het project. De planning wordt uitgewerkt en afspraken tussen opdrachtgever en ontwikkelaar worden uitgewerkt. 3.2 Userstories Om een indruk te krijgen wat het systeem moet kunnen zijn userstories geschreven. Dit zijn op een hoog abstractieniveau geschreven leesbare verhaaltjes waarin duidelijk wordt wat verwacht wordt van het systeem. Aan de hand hiervan is het mogelijk om verder onderzoek te verrichten naar de te implementeren globale functionaliteit. 3.3 Requirements Analysis In de Requirements Analysis zijn de globale requirements van de userstories dieper uitgewerkt. Er wordt hier op een lager abstractieniveau uitgebreid uitgewerkt wat het systeem exact moet kunnen. Hierin worden de toekomstige functionaliteiten uitgewerkt in verschillende categoriën. Ook worden de gevaren uitgewerkt. De Requirements Analysis dient als naslagwerk tijdens de ontwerpfase en implementatiefase. De gemaakte software moet voldoen aan de requirements. 3.4 Architectural Design Het systeem wordt uitgewerkt in componenten en hun subcomponenten. De architectuur van de software wordt uitgewerkt. Hierbij wordt zorgvuldig rekening gehouden met de implementatiefase, maar vooral ook na de implementatiefase. De software moet goed onderhoudbaar en testbaar zijn. Door de componenten en subcomponenten zo zorgvuldig mogelijk 16

19 IN Bachelorproject - dbquery CHAPTER 3. VOORONDERZOEK te ontwerpen kan coupling worden gereduceerd, afhankelijkheden worden geoptimaliseerd en kan ervoor worden gezorgd dat de software ook in de toekomst onderhoudbaar blijft. 3.5 Test and Implementation plan In dit document wordt uitgewerkt wat er precies geimplementeerd gaat worden. Aan de hand van het MoSCoW model wordt aangetoond welke requirements uit de Requirements Analysis essentieel zijn voor het systeem, welke wenselijk zijn en welke zouden kunnen worden geimplementeerd mocht de tijd dat toelaten. Ook wordt uitgewerkt hoe de software getest gaat worden. 17

20 Chapter 4 Procesverslag In het komende hoofdstuk wordt per week van het project kort uitgelegd wat er gedaan is en hoe ik deze weken heb ervaren /07/ /07/2012 In de eerste week van het project is veelvuldig overleg gepleegd met de opdrachtgever. In deze gesprekken is naar voren gekomen wat de huidige situatie voor problemen oplevert. Ook is de visie besproken waarmee dit zou kunnen worden opgelost. Aan de hand van deze gesprekken heb ik userstories geschreven. Deze userstories zijn tot stand gekomen door gezamelijk overleg. Hierdoor was geen draft nodig, de final version is donderdag 5 juli getoond aan de opdrachtgever die het goed vond. Op vrijdag 6 juli ben ik begonnen met de requirements analysis /07/ /07/2012 Het was in deze week veel nodig om onderzoek te doen naar wat er mogelijk is en wat er onmogelijk is om te doen. Hiervan is de realiseerbaarheid van de ideeën onderzocht en besproken. Aan de hand van deze besprekingen en de userstories zijn de requirements tot stand gekomen. Deze zijn uitgewerkt tot een requirements analysis. De draft heb ik op vrijdag (in overleg een dag nadat ik hem in zou leveren) ingeleverd bij de opdrachtgever /07/ /07/2012 In het weekend voorafgaand aan deze week heb ik onderzocht wat een architectural design moest bevatten, zodat ik maandag direct aan de slag kon. Aan de hand van de requirements analysis was het maken van een architectural design een aangename bezigheid die goed uitpakte. Ik heb hier in het weekend al een groot deel van geschreven. In datzelfde weekend had de opdrachtgever de requirements analysis doorgenomen. Na wat kleine aanpassingen heb ik dinsdag 13 juli de final version al kunnen overhandigen, waar de opdrachtgever erg blij mee was. De draft van het architectural design heb ik op de woensdag in de ochtend ingeleverd. Diezelfde middag heb ik met de opdrachtgever de architectural design besproken. Hij was positief verrast en vond de gevonden software architectuur erg goed. Na de bespreking ben ik begonnen met het schrijven van het test and implementation plan. Na 18

21 IN Bachelorproject - dbquery CHAPTER 4. PROCESVERSLAG het schrijven van de requirements analysis en architectural design was dit niet lastig. Alles zat al in mijn hoofd. Op de donderdag heb ik de draft van het test and implementation plan ingeleverd. De opdrachtgever wilde meer weten over QUnit en PHPUnit, na deze onderwerpen te hebben besproken is de test and implementation plan goedgekeurd en kon begonnen worden aan de implementatiefase /07/ /07/2012 Het begin van de implementatiefase heeft voornamelijk bestaan uit het schrijven van de PHP testklassen en PHP klassen die gebruikt worden in dbquery. Hierbij gaat het om dbobject.inc.php en dbattribute.inc.php. De functionaliteit van de functies is geimplementeerd, waarbij steeds slimmere algoritmes elkaars werk opvolgden. Rekening is gehouden met het direct documenteren van de code. De gehele PHP klassen dbobject en dbattribute zijn in de eerste week geimplementeerd. en testcases voor deze klassen zijn na de eerste week al geslaagd /07/ /08/2012 In het weekend voorafgaand aan deze week is de webservice q.php geschreven. Deze webservice maakt gebruik van dbobject.inc.php (en dbattribute.inc.php) en is aanspreekbaar voor de buitenwereld en dus ook door javascript. Gedurende de week is de javascript van het project ontwikkeld. Dit begon met testklassen over de testdatabase. Na het implementeren van het javascriptdeel dat de webservice aanspreekt en dynamisch objecten aanmaakt, werden de verschillende methoden van dbquery geschreven. Hierna was het van belang datums goed af te handelen in javascript, daar javascript en PHP verschillend met datums om gaan. Het implementeren van dit laatste deel van het eidproduct was zeer motiverend. Deze week is vrijwel iedere avond tot zeer laat doorgewerkt omdat het heel bevredigend is steeds dichter bij het gewenste eindresultaat te komen. Vanaf vrijdag was dbquery bruikbaar in de console /08/ /08/2012 Deze week is de code gefinetuned. Documentatie van de code (zowel inline als in dit document) is verfijnd en algoritmen zijn versneld. Er is veel werk besteed aan het verfijnen van het eindverslag en het completeren van de code. Functionaliteit om callbacks uit te voeren is omgezet van timeouts (het stilleggen van de uitvoering van code tot andere code is uitgevoerd) naar sequentiele callbacks. Hier is veel tijd in gaan zitten maar het maakt de code veel schoner en onderhoudbaarder /08/ /08/2012 Omdat dbquery opensource is, moet er een website zijn waar mensen de source-code kunnen downloaden. Zij moeten hier documentatie kunnen vinden van de code en zij moeten db- Query kunnen uitproberen. In deze week is er veel aandacht besteed aan de website. Quentin Buiteman heeft een ontwerp gemaakt en samen met hem heb ik de website afgemaakt. Er is Engelstalige documentatie geschreven en een plaats waar mensen de code kunnen uitproberen (live). Tijdens het maken van de website is geconstateerd dat dbquery niet werkte 19

22 IN Bachelorproject - dbquery CHAPTER 4. PROCESVERSLAG onder Internet Explorer 7. Doordat deze webbrowser een zeer slechte error-console heeft, ben ik veel tijd kwijt geweest aan het oplossen van deze bug. Gedurende het gehele proces is gewerkt aan het verslag. 4.8 Reflectie Tijdens de onderzoeksfase heb ik in samenwerking met Anan6 BV een heel ambitieus software plan geschreven. Tijdens de implementatiefase leek het er soms op dat deze plannen te ambitieus waren, maar doordat het architectural design goed gevolgd kon worden is de software volledig werkend opgeleverd. Vanaf het eerste moment dat een object uit de database kon worden gehaald (en er verder nog niets mee gedaan kon worden), groeide het enthousiasme enorm. Ik ben in de avonduren door gaan werken en heb veel kunnen doen. Het enthousiasme en de tevredenheid van opdrachtgever Larry Poort hielp er ook in mee. Ik heb het gevoel dat ik iets waardevols heb ontwikkeld en ben hier erg trots op. 20

23 Chapter 5 Documentatie In het volgende hoofdstuk wordt de documentatie van de clientside van javascript uitgewerkt. Voor iedere functie worden de parameters en de return values uitgewerkt. Voorafgaand hieraan wordt besproken hoe dbquery te installeren is op een server. Ook zullen er voorbeelden aanwezig zijn van hoe dbquery gebruikt kan worden. 5.1 Hoe dbquery werkt dbquery is een javascript framework die het mogelijk maakt met elke MySQL database te communiceren door slechts gebruik te maken van normale javascript. Het is niet nodig om enige serverside programmeertaal te kennen om toegang te krijgen tot deze databases. Door de methode db() aan te roepen, kan de database worden benaderd. De db() functie retourneert een (collectie van) javascript object(en), met al zijn attributen geinitialiseerd zoals ze gedefinieerd zijn in de database. Het geretourneerde object bevat de methoden getattribute(), setattribute(), save() en remove(), welke het mogelijk maken om regels in de database toe te voegen, aan te passen en te verwijderen. Om een db() object te initialiseren, zijn er drie parameters nodig: Selector De database en tabelnaam die aangesproken moeten worden. Filter Een filterobject dat het mogelijk maakt om een selectie van rijen te maken uit de database. Standaard is dit de identifier. Callback Deze functie wordt uitgevoerd wanneer alle rijen uit de database zijn gehaald en in javascript zijn geinitialiseerd. De parameter van de callback hangt af van de aanroep van de db() functie. 5.2 Installatie Om dbquery te gebruiken zijn er verschillende bestanden nodig: Serverside dbquery.config bevat informatie waarmee dbquery kan worden geconfigureerd (zie 5.3). 21

24 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE dbobject.inc.php bevat de klasse dbobject, welk gebruikt wordt voor databasecommunicatie. dbattribute.inc.php bevat de klasse dbattribute, welk gebruikt wordt door dbobject om attributen af te handelen. q.php worden aanroepen naar gedaan vanaf de client. beschikbaar zijn voor buitenaf. Dit bestand moet dan ook Clientside jquery.js wordt gebruikt om ajax calls te maken naar de server. dbquery.js handelt alle objecten en handelingen af. De bestanden dbobject.inc.php, dbattribute.inc.php, dbquery.config en q.php moeten op de server worden geplaatst. In de HTML pagina s waar dbquery gebruikt gaat worden moeten jquery.js en dbquery.js worden geinclude in de header met de volgende code: 1 <head > 2 < script type =" text / javascript " src ="/ pad / naar / jquery.js" ></ script > 3 < script type =" text / javascript " src ="/ pad / naar / dbquery.js" ></ script > 4 </head > 5.3 Configuratie In het bestand dbquery.config moet worden aangegeven hoe dbquery met de database kan communiceren. De volgende gegevens zijn aanpasbaar: Verplicht $ HOST_OF_THE_DATABASE Dit is de hostnaam van de database. Dit kan een IP-adres zijn, of een traceerbare URL. Standaardwaarde is localhost. $ USER_OF_THE_DATABASE Dit is de databasegebruiker waarmee dbquery kan inloggen op MySQL. $ PASSWORD_OF_THE_DATABASE Dit is het wachtwoord van de databasegebruiker waarmee dbquery kan inloggen op MySQL. Optioneel $ PATH_TO_DBOBJECT Wanneer dbobject.inc.php, dbattribute.inc.php niet in dezelfde directory zitten als dbquery.config, moet dit veld worden ingevuld. $ DEFAULT_DATABASE Om dbquery zo eenvoudig mogelijk te gebruiken is het handig om een standaard database in te vullen (zie 5.4). 22

25 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE $ READ_ONLY_MODE Wanneer dbquery gebruikt wordt om slechts de database uit te lezen en geen aanpassingen te doen, moet dit op true worden gezet. Standaardwaarde is false. Objecten aanmaken 5.4 db() De functie db is de hoofdfunctie van dbobject. db wordt gebruikt om objecten uit de database te maken of om een los object aan te maken. Hierbij zijn verschillende parameters mogelijk. Functie db( tabelnaam [, selectie ] [, handler(eventobject) ) Retourneert een array met objecten uit de database die aan de selectiecriteria voldoen, en een dbobject wanneer de selectie uit een integer bestaat. tabelnaam Naam van de tabel waar een object van aangemaakt moet worden, optioneel voorafgegaan door de databasenaam gescheiden met een punt. selectie De selectie heeft twee verschillende mogelijkheden: 1. Integer Een integer die het ID is van de op te vragen rij in de tabel. 2. Array Een array met selectiecriteria. De index is het attribuut, de waarde is de verplichte waarde. handler(eventobject) Callback die wordt uitgevoerd wanneer de objecten uit de database zijn gehaald. Wanneer er slechts een enkel object uit de database moet worden gehaald, kan db als constructor worden gebruikt. Nu is de eventobject het object, in plaats van de array met objecten Voorbeeld 1 In dit eenvoudige voorbeeld wordt een klant uit de database gehaald en gelogd. Omdat het om slechts 1 klant gaat, wordt de constructor (new) gebruikt. 1 new db( klanten,1, function ( klant ) { 2 console. log ( klant ); 3 }); Voorbeeld 2 In dit voorbeeld wordt een klant uit de database gehaald en gelogd. Omdat nu de constructor niet gebruikt wordt, wordt een array geretourneerd. 1 db( klanten,1, function ( klanten ) { 2 console. log ( klanten [0]) ; 3 }); 23

26 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE Voorbeeld 3 In dit voorbeeld worden alle klanten van 23 uit de database gehaald en wordt gelogd hoeveel dat er zijn. 1 db( klanten, { leeftijd : 23 }, function ( klanten ) { 2 console. log ( klanten. length ); 3 }); Voorbeeld 4 In dit voorbeeld worden actieve klanten van 20 jaar oud uit de database gehaald en wordt hun bijnaam aangepast. 1 db( klanten, { leeftijd : 20, status : actief }, function ( klanten ) { 2 klanten. foreach ( function ( klant, i) { 3 klant. setattribute ( bijnaam, 20 jarige nummer +i). save (); 4 }); 5 }); Objecten gebruiken De volgende functies hebben betrekking tot objecten die in de callback van db kunnen worden gebruikt. 5.5 dbobject.getattribute() De functie getattribute kan gebruikt worden om een attribuut van een object op te vragen. Wanneer dit attribuut een sleutel is naar een andere tabel, wordt dit object opgehaald. Functie.getAttribute( attribute, handler(eventobject) ) Retourneert het attribuut dat wordt opgevraagd. attribute Op te vragen attribuut. handler(eventobject) Een functie die wordt uitgevoerd wanneer het attribuut een sleutel is, waarin eventobject het opgevraagde dbobject is Voorbeeld 5 In dit voorbeeld wordt een klant aangemaakt en wordt zijn naam geoutput. Vervolgens wordt zijn adres opgevraagd, die in een aparte tabel staat. Hiervan wordt de postcode geoutput. 1 new db( klanten,1, function ( klant ) { 2 // normale attribuut opvraag 3 console. log ( klant. getattribute ( naam )); 4 // adres linkt naar een andere tabel 5 klant. getattribute ( adres, function ( adres ) { 6 console. log ( adres. getattribute ( postcode )); 7 }); 8 }); 24

27 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE Voorbeeld 6 In dit voorbeeld wordt een callback vooraf gedefinieerd, en losgelaten op ieder adres van de klant met leeftijd var remove = function ( adres ) { 2 adres. remove (); 3 } 4 db( klanten,{ leeftijd : 23 }, function ( klanten ) { 5 klanten. foreach ( function ( klant ) { 6 // gebruik vooraf gedefinieerde callback 7 klant. getattribute ( adres, remove ( adres )); 8 }); 9 }); 5.6 dbobject.setattribute() De functie setattribute kan gebruikt worden om een attribuut van een object aan te passen. Functie.setAttribute( attribute, newvalue) Retourneert het dbobject waarop de functie wordt aangeroepen, zodat de functie gechained kan worden. attribute Aan te passen kolomnaam. newvalue Nieuwe waarde van de kolom Voorbeeld 7 In dit voorbeeld wordt klant met identifier 1 uit de database gehaald. Zijn naam, voornaam en opleiding worden aangepast. 1 new db( klanten,1, function ( klant ) { 2 // aanpassingen maken 3 klant. setattribute ( naam, Plak ) 4. setattribute ( voornaam, Rutger ) 5. setattribute ( opleiding, Technische Informatica ); 6 }); 5.7 dbobject.save() De functie save kan gebruikt worden om gemaakte aanpassingen in een object op te slaan. Functie.save( handler(eventobject)) Retourneert het dbobject waarop de functie wordt aangeroepen, zodat de functie gechained kan worden. Doordat bij een save() een call naar de database moet worden gemaakt en soms informatie uit de database moet worden gehaald, is een callback beschikbaar. 25

28 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE Voorbeeld 8 In dit voorbeeld wordt klant met identifier 1 uit de database gehaald. Zijn naam, voornaam en opleiding worden aangepast. Vervolgens worden deze wijzigingen opgeslagen in de database. 1 new db( klanten,1, function ( klant ) { 2 // aanpassingen maken 3 klant. setattribute ( naam, Plak ) 4. setattribute ( voornaam, Rutger ) 5. setattribute ( opleiding, Technische Informatica ) 6 // opslaan 7. save (); 8 }); Voorbeeld 9 In dit voorbeeld wordt een nieuwe klant aangemaakt. Zijn naam, voornaam en opleiding worden aangepast. Vervolgens worden deze wijzigingen opgeslagen in de database. De identifier van de nieuwe klant is nodig, deze is pas beschikbaar na de databasecall. De identifier wordt gelogd in de callback. 1 new db( klanten,0, function ( klant ) { 2 // aanpassingen maken 3 klant. setattribute ( naam, Plak ) 4. setattribute ( voornaam, Rutger ) 5. setattribute ( opleiding, Technische Informatica ) 6 // opslaan 7. save ( function ( klant ) { 8 console. log ( klant. getattribute ( klant )); 9 }); 10 }); 5.8 dbobject.remove() De functie remove 1 kan gebruikt worden om een object uit de database te halen. Functie.remove(handler(eventObject)) Na het verwijderen van een object uit de database, moeten er soms op een pagina taken worden uitgevoerd. Bij het verwijderen van een entry in een tabel, moet deze entry nadat hij uit de database is verwijderd ook van de pagina worden verwijderd. Hiervoor is een callback beschikbaar. eventobject is hierbij de identifier van het verwijderde object Voorbeeld 10 In dit voorbeeld wordt de klant met identifier 1 uit de database verwijderd. 1 new db( klanten,1, function ( klant ) { 2 // klant met id 1 uit de database halen 3 klant. remove (); 4 }); 1 In de initiele versie van dbquery heette deze functie delete(), maar die functienaam was gereserveerd in Internet Explorer 7 en gaf problemen. 26

29 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE Voorbeeld 11 In dit voorbeeld wordt een klant verwijderd aan de hand van een verwijder button in een tabel 1 $( # mytable tr td. remove ). bind ( click, function () { 2 // dbobject aanmaken van klanten met het id van de tr 3 new db( klanten,$( this ). parent (). attr ( id ), function ( klant ) { 4 // klant met id van de tr uit de database halen 5 klant. remove ( function ( klantid ) { 6 // tr met klantid verwijderen 7 $( tr# + klantid ). remove (): 8 }); 9 }); 10 }); 5.9 Uitgebreid voorbeeld In het volgende voorbeeld wordt een idee geschetst hoe een combinatie van de functies kan worden gebruikt om eenvoudig een tabel aan te maken van een databasetabel met selectiecriteria, en hoe aan de hand van user-events de database kan worden aangepast. Het scenario is volledig fictief en niet praktijkgericht. customers orders orderitems products De aanwezige foreign keys zijn: orderitems.product products orderitems.order orders orders.customer customers 1 // Alle orderitems uit de database halen met een willekeurig selectiecriterium ( amount = 1, in dit geval ) 2 db( orderitems, { amount : 1}, function ( orderitems ) { 3 var otable = document. createelement ( table ); 4 // voor ieder van de orderitems 5 orderitems. foreach ( function ( orderitem ) { 6 var otr = document. createelement ( tr ); 7 otr. setattribute ( id, orderitem. getattribute ( orderitem )); 8 var otd = document. createelement ( td ); 9 otd. innerhtml = " Orderitem nummer :" + orderitem. getattribute ( orderitem ) 10 otr. appendchild ( otd ); 11 // product ophalen 12 orderitem. getattribute ( product, function ( product ) { 13 var otd = document. createelement ( td ); 14 otd. innerhtml = product. getattribute ( name ) + : + product. getattribute ( description ); 15 otr. appendchild ( otd ); 16 }); 27

30 IN Bachelorproject - dbquery CHAPTER 5. DOCUMENTATIE 17 // order ophalen 18 orderitem. getattribute ( order, function ( order ) { 19 var otd = document. createelement ( td ); 20 otd. innerhtml = aankoop gedaan op + order. getattribute ( date ); 21 otr. appendchild ( otd ); 22 // klant ophalen 23 order. getattribute ( customer, function ( customer ) { 24 var otd = document. createelement ( td ); 25 otd. innerhtml = customer. getattribute ( firstname ); 26 otr. appendchild ( otd ); 27 var otd = document. createelement ( td ); 28 otd. innerhtml = customer. getattribute ( street ); 29 otr. appendchild ( otd ); 30 var otd = document. createelement ( td ); 31 otd. innerhtml = customer. getattribute ( zipcode ); 32 otr. appendchild ( otd ); }); 35 }); 36 // wanneer er op de tr geklikt wordt, moet delorder worden uitgevoerd. 37 otr. setattribute ( onclick, delorder ( this )); 38 otable. appendchild ( otr ); 39 }); 40 document. getelementsbytagname ( body ) [0]. appendchild ( otable ); 41 }); 42 // functie om de order en het orderitem te verwijderen en de klant aan te passen 43 var delorder = function ( otr ) { 44 // opvragen om welke orderitem het gaat 45 var iid = otr. id; 46 db( orderitems, iid, function ( orderitem ) { 47 // order opvragen 48 orderitem. getattribute ( order, function ( order ) { 49 // klant opzoeken 50 order. getattribute ( customer, function ( customer ) { 51 // klant aanpassen 52 customer. setattribute ( name, nieuwe naam ) 53. setattribute ( firstname, nieuwe voornaam ) 54. save (); 55 }); 56 // order verwijderen 57 order. remove (); 58 }); 59 // orderitem verwijderen 60 orderitem. remove (); 61 }); 62 // rij verwijderen uit tabel 63 otr. parentnode. removechild ( otr ); 64 } Dit voorbeeld bestaat uit het halen van orderitems uit de database. Hierbij worden alleen de orderitems waarbij 1 object is besteld uit de database gehaald. Voor ieder orderitem wordt een regel aangemaakt in een tabel. Het bestelde product wordt opgehaald en in de regel gezet. Ook de datum waarop de order is gedaan en de klant worden in dezelfde regel verwerkt. Daarnaast is er nog een verwijderknop, die een functie aanroept waarbij de order verwijderd wordt. 28

31 Chapter 6 Testen Voor het onderhoudbaar maken van software dienen testcases voldoende aanwezig te zijn. Wenselijk is het dat alle functionaliteit van de software getest wordt. Alle functies moeten worden getest, evenals alle branches binnen deze functies. Tevens moet de onderlinge samenhang van de software worden getest. Componenten moeten goed samenwerken. Ten slot is het van belang dat de software voor de eindgebruiker werkt zoals de eindgebruiker verwacht. Voor PHP is gekozen voor PHPUnit als testsoftware. Voor Javascript is gekozen voor QUnit als testsoftware. In het volgende hoofdstuk wordt uitgewerkt hoe de tests geschreven zijn en hoe het testproces verlopen is. 6.1 Unit testing Bij unit testing worden individuele units van de software getest. Hierbij wordt iedere functie van een klasse getest. Er worden handelingen op objecten uitgevoerd en er wordt gecontroleerd of de verwachte output wordt bereikt PHP In PHP zijn dbobject.inc.php en dbattribute.inc.php getest. Hierbij worden alle functionaliteiten van dbobject.inc.php getest, waar dbattribute aan hangt. Voor iedere functie van dbobject.inc.php zijn een of meerdere testcases geschreven, die alle mogelijkheden binnen de functies dekken. Hierbij is een line-coverage score van 100% behaald voor zowel dbobject.inc.php als dbattribute.inc.php. Hiervoor is gebruik gemaakt van PHPUnit coverage: Figure 6.1: Coverage report voor dbobject.inc.php & dbattribute.inc.php 29

32 IN Bachelorproject - dbquery CHAPTER 6. TESTEN Figure 6.2: Coverage report van dbobject.inc.php Figure 6.3: Coverage report van dbattribute.inc.php Figure 6.4: Deel van de code in het coverage report Er volgt nu een van de testcases om een beeld te schetsen over testcases voor de PHP klassen binnen dbquery: 1 /** 2 * function to check if floats can be set 3 * check if the float save function works 4 */ 5 public function testfloat () { 6 $oobject = new dbobject ( dbquerytestdb. products,1); 7 $foldvalue = $oobject - > getattribute ( price ); 8 $oobject -> setattribute ( price,10.50) ; 9 $oobject -> save (); 10 $oobject = new dbobject ( dbquerytestdb. products, $oobject - > getattribute ( product )); 11 $this -> assertequals (10.50, $oobject -> getattribute ( price )); 12 $oobject -> setattribute ( price, $foldvalue ); 13 $oobject -> save (); 14 } Deze testcase is geschreven om te controleren of een float correct wordt opgeslagen in de database. Er wordt een object aangemaakt en zijn prijs wordt gezet. Het object wordt opgeslagen en de float moet goed in de database komen. Om dat te controleren wordt het object weer uit de database gehaald en wordt de waarde van de prijs gecontroleerd. Voor iedere functie zijn zulke testcases geschreven. 30

33 IN Bachelorproject - dbquery CHAPTER 6. TESTEN Javascript Omdat dbquery een javascript plugin betreft, is er slechts één bestand dat getest moet worden. Dit bestand is dbobject.js. Hierin bestaan verschillende functies. De constructor db(), zoals omschreven in de documentatie, kan worden gebruikt om objecten aan te roepen uit de database. Vervolgens kunnen met deze objecten verschillende handelingen worden verricht. Door al deze handelingen in testcases uit te voeren en de output te vergelijken met de verwachtte output, kan de software worden getest. Nu haalt de javascript van dbquery alle data uit de database. Omdat de serverside software onafhankelijk moet worden onderhouden van de javascript software, is het belangrijk dat de testcases van javascript niet falen als de server niet werkt. De componenten moeten onafhankelijk worden getest. Om dit te bereiken wordt de server gemocked aan de hand van MockJax. Er worden berichten teruggestuurd die aan de vooraf gedefinieerde standaarden voldoen. Hierdoor zullen javascript testcases gewoon slagen wanneer de server niets terugstuurt. De onderlinge samenwerking van de server en de client wordt behandeld bij integration testing. Voor alle functionaliteit van de javascript zijn testcases geschreven. Hierbij is een linecoverage van 84% behaald. Deze berekening is gemaakt door JSCoverage: Figure 6.5: Coverage report voor dbquery.js & afhankelijke libraries (niet getest) Figure 6.6: Deel van de code om een beeld te schetsen van een coverage report Er volgt nu een van de testcases om een beeld te schetsen over testcases voor de javascript binnen dbquery: 1 /** 2 * tests if invalid dates are ignored 3 */ 4 new db( orders, 0, function ( order ) { 5 var shopdate = new Date (); 6 order. setattribute ( date, shopdate ); 7 order. setattribute ( date, test ); 8 // Als de datum nog gelijk is aan shopdate, is de tweede setattribute genegeerd 31

34 IN Bachelorproject - dbquery CHAPTER 6. TESTEN Figure 6.7: Visuele output van qunit 9 equal ( order. getattribute ( date ), shopdate, Invalid date is ignored ); 10 start (); 11 }); In deze functie doet db() een aanroep naar de server. Deze wordt gemocked door MockJax: 1 /** NEW ORDER **/ 2 $. mockjax ({ 3 url : q. php, 4 data : { 5 action : get, 6 data : { 7 tablename : orders, 8 identifier : null 9 } 10 }, 11 responsetext : {" status ":" success "," msg ":" The requested item (s) ha(s)(ve) been succesfully loaded from the database."," action ":" get "," result ":{" found ":""," resultset ":[{" sdatabase ":" dbquerytestdb "," stablename ":" orders "," skeyname ":" order ",... // volledige response zoals vooraf gedefinieerd 12 }); 32