README.adoc 13.4 KB
Newer Older
Gerson Sunyé's avatar
Gerson Sunyé committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
= Online Chess

Ce projet consiste à déployer une application web de jeu d'échecs jouable en multijoueur.

== Objectifs

La fin du semestre approche, il est temps de montrer tout ce que vous avez appris et de proposer au monde entier votre première application web (webapp) !
L'objectif de ce mini-projet est d'intégrer et adapter tout le travail réalisé lors des TP et TD précédents, afin de réaliser une application de jeu d'échecs jouable (et observable) en multijoueur réseau.

== Préparation

. Créez une divergence (en anglais, _fork_) du projet sur votre compte GitLab: https://gitlab.univ-nantes.fr/naomod/idl/projet-2019/forks/new[Cliquez ici pour créer le Fork] (Éventuellement, Gitlab vous demandera de vous connecter).

. Créez et configurez une copie locale du projet. Ouvrez le *Terminal* et exécutez les commandes suivantes:

[source,bash]
----
git clone https://gitlab.univ-nantes.fr/${USER}/projet-2019.git
cd projet-2019
npm install
----

. Regardez la structure du projet. Le projet est organisé en différents dossiers:
[source,txt]
----
26
    |-- projet-2019
Gerson Sunyé's avatar
Gerson Sunyé committed
27
28
29
30
31
      |-- client
         |-- index.html
         |-- script.js
         |-- style.css
      |-- src
32
33
34
35
36
37
38
39
40
41
42
43
        |-- main
          |-- ts
            |-- chessboard.ts
            |-- main.ts
            |-- move-validation.ts
            |-- movements.ts
            |-- piece.ts
            |-- position.ts
        |-- test
          |-- ts
            |-- move-validation.spec.ts
            |-- movements.spec.ts
Gerson Sunyé's avatar
Gerson Sunyé committed
44
45
46
47
48
49
50
51
52
      |-- node_modules
      |-- package.json
      |-- tsconfig.json
----

* `client` contient le code Javascript qui sera exécuté sur le browser. Vous ne devez pas modifier le contenu de ce dossier.
* `index.html` : page principale de l'application
* `style.css` : mise en forme de l'application
* `script.js` : algorithme(s) JavaScript côté client (affichage de l'échiquier)
53
* `src/main/ts` contient le code source du serveur.
Gerson Sunyé's avatar
Gerson Sunyé committed
54
* `main.ts` : programme principal de création et gestion du serveur web
55
* `src/test/ts` contient les tests unitaires du serveur.
Gerson Sunyé's avatar
Gerson Sunyé committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
* `node_modules` contient les modules Node.js utilisés dans le projet. Vous ne devez pas modifier le contenu de ce dossier.
* `package.json` est le fichier de configuration de *npm*. Vous n'avez pas besoin de le modifier.
* `tsconfig.json` est le fichier de configuration de *TypeScript*. Vous n'avez pas besoin de le modifier.

== Test et lancement

* Le projet utilise l'outil de construction et de gestion de modules *npm*.
* Pour lancer tous les tests unitaires du projet avec Alsatian, exécutez: `npm test`.
* Pour lancer le serveur en mode développement, exécutez: `npm run dev`.
* Pour accéder à l'application, ouvrez l'URL suivante: http://localhost:8080.
* Pour accéder au contenu JSON de l'échiquier en cours, utilisez l'URL suivante: http://localhost:8080/status.js.

== Manuel d'utilisation

Pour déplacer les pièces sur l'échiquier, indiquez dans le formulaire en bas de page la pièce à déplacer et sa destination.
Utilisez la notation par coordonnées, qui inclut la place à partir de laquelle la pièce se déplace, ainsi que sa destination.

73
.Par exemple:
Gerson Sunyé's avatar
Gerson Sunyé committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|===
|Coup |Coordonnées |Description 

| 1. |E2-E4 E7-E5 |Pion blanc en E2 se déplace à E4. Pion noir en E7 se déplace à E5.
| 2. |G1-F3 B8-C6 |Cheval blanc en G1 se déplace à F3. Cheval noir en B8 se déplace à C6.
|===

== Fonctionnement de l'application

Le programme principal du serveur (`main.ts`) est chargé de démarrer un mini-serveur web capable de recevoir les différentes requêtes provenant des navigateurs connectés à l'application :

* GET "`/`" : distribue le fichier `views/index.ejs`;
* GET "`/status.js`" : génère et distribue l'échiquier en cours au format JSON.
* POST "`/`" : reçoit et traite un coup à jouer;

Ces trois traitements correspondent aux différents appels à `app.get()` et `app.post()` du programme principal.

== Chronologie d'une partie

. Lorsqu'un utilisateur se connecte à l'application (adresse *"/"*), le serveur distribue alors la page html principale composée d'un échiquier vierge et d'une zone de saisie permettant à l'utilisateur de remplir le coup à jouer.

. Le navigateur internet récupère immédiatement les informations de la partie en cours présentes à l'adresse `/status.js` et remplit l'échiquier à l'aide d'un script situé dans le fichier `script.js`. Ces deux scripts se trouvent dans le dossier `client`.

. Un clic sur le bouton "Envoyer" effectue une requête de type *POST* au à l'adresse *"/"* du serveur, contenant les informations du champs de texte associé.
Le serveur traite alors la requête afin de jouer le coup demandé.

. La page internet du joueur est alors rechargée automatiquement, affichant ainsi le nouvel état de la partie.

. etc…

== Travail à réaliser

=== Validation des mouvements

La version actuelle permet le déplacement libre des pièces, sans respecter les règles des échecs.
Pour l'instant, seuls les déplacements des pions sont validés.
Vous devez mettre en oeuvre la validations des déplacements des autres pièces: le Roi, la Dame, le Cavalier, le Fou et la Tour. 

Le traitement des déplacements se fait de la façon suivante:

. Lorsqu'une requête *POST* arrive, le serveur extrait la valeur du champ envoyé et appelle la fonction `processMove()` du module `movements`.

. La fonction `processMove()` appelle une autre fonction, `parseMoveString()`, qui transforme une chaîne de caractères en un déplacement (`interface Move`) entre 2 positions (`interface Position`).

118
119
. La fonction `processMove()` appelle ensuite la fonction `isMovePossible()`, qui fait appel à différentes fonctions de validation spécifiques aux pièces de l'échiquier (une par type de pièce). 
Le module `move-validation` contient toutes les fonctions de validation de déplacements.
Gerson Sunyé's avatar
Gerson Sunyé committed
120
121
122

. Par exemple, lorsqu'il s'agit d'un Pion blanc, la fonction `isMovePossible()` appelle la fonction `whitePawnMove()`, qui retourne `true` si le déplacement est possible ou `false` si ce n'est pas le cas.

123
. Si le mouvement est possible, c'est à dire la fonction `isMovePossible()` retourne `true`, la fonction `processMove()` appelle la fonction `performMove()`, qui effectue le déplacement.
Gerson Sunyé's avatar
Gerson Sunyé committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

Vous devez donc parcourir le module `move-validation` et implémenter les fonctions de validation contenant le commentaire "`// #TODO:`". 

=== Tests unitaires

Pour vérifier que les fonctions du module `move-validation` fonctionnent correctement, vous devez écrire des tests unitaires, qui vont vérifier que les fonctions acceptent les mouvements possibles et n'acceptent pas les mouvements impossibles.
Les mouvements sont possibles (ou impossibles) en accord avec les https://fr.wikipedia.org/wiki/Échecs[règles des échecs].
Comme ces règles sont complexes, vous serez mené à écrire plusieurs tests unitaires pour vérifier les mouvements possibles et impossibles d'une même pièce.

Les signatures des fonctions du module `move-validation` suivent la même convention :

[source,ts]
----
function colorPieceMove(board: Chessboard, move: Move): boolean
----

Le paramètre `board` contient l'échiquier de la partie en cours et `move` contient le déplacement demandé par le joueur à travers le browser.
Le paramètre `move` contient 2 coordonnées de type `Position`, représentant le début et la fin du déplacement.
Les coordonnées indiquent *toujours* des cases à l'intérieur de l'échiquier, c'est à dire, une colonne entre `A` et `H` et une ligne entre `1` et `8`.
Donc, il n'y a pas besoin de vérifier si un déplacement conduit une pièce à l'extérieur de l'échiquier.

145
Les tests unitaires de la fonction `blackPawnMove()` ont déjà été implémentés, vous les trouverez dans le fichier `./src/test/ts/pawn-move-validation-spec.ts`.
Gerson Sunyé's avatar
Gerson Sunyé committed
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
*Vous devez compléter tous les squelettes de tests unitaires fournis à l'intérieur de ce fichier !* 

Vous devez procéder par itérations successives, n'essayez pas d'implémenter les fonctions d'un seul trait. Observez le cycle de développement suivant:

. Implémentez une fonctionnalité simple.
. Écrivez le ou les tests unitaires qui vérifient cette fonctionnalité.
. Exécutez les tests pour vérifier que la fonctionnalité marche correctement et la non-régression.
. Recommencez avec la fonctionnalité suivante.

Par exemple, lorsque vous allez implémenter les fonctions qui valident le mouvement des tours (`blackRookMove()` et `whiteRookMove()`) , vous pouvez subdiviser leurs comportements en différentes fonctionnalités: 

* Validation des mouvements horizontaux, sans se préoccuper des autres pièces.
* Validation des mouvements verticaux, toujours sans se préoccuper des autres pièces.
* Invalidation d'des mouvements (horizontaux et verticaux) lorsque la case finale contient une pièce de même couleur.
* Validation des mouvements (horizontaux et verticaux) qui se terminent sur une case contenant une pièce d'une couleur différente.
* Invalidation des mouvements (horizontaux et verticaux) lorsque toutes les cases intermédiaires ne sont pas vides.

=== Exemple: validation des mouvements d'une tour en plusieurs étapes

==== Etape 1

Commencez par la 1e fonctionnalité, la validation des déplacements horizontaux:

[source,ts]
----
// Dans le fichier "move-validation.ts"
export function rookMove(board: Chessboard, move: Move): boolean {
    return move.from.rank === move.to.rank; // Si les lignes de début de fin sont les mêmes, le déplacement est horizontal
}
----

Écrivez ensuite le test unitaire pour cette fonctionnalité:

[source,ts]
----
181
182
183
184
// Dans le fichier "rook-move-validation.spec.ts"
let chessboard : Chessboard;

export class TestRookMoves {
185
186
    @Setup
    beforeEach(){
Gerson Sunyé's avatar
Gerson Sunyé committed
187
188
189
190
191
        chessboard = createEmptyChessboard();

        // La variable "positionE4" a été créée au début du module pour simplifier le code des tests
        // Place une tour sur la case E4 d'un échiquier vide:
        putPiece(chessboard, positionE4, pieces.blackPawn);
192
    }
Gerson Sunyé's avatar
Gerson Sunyé committed
193

194
195
    @Test("A rook can move horizontally")
    testCanMoveHorizontally() {
Gerson Sunyé's avatar
Gerson Sunyé committed
196
197
198
        // Les variable "moveE4_H4" et "moveE4_14" ont été créées au début 
        // du module pour simplifier le code des tests.
        // Le déplacement doit être possible:
199
200
201
202
        Expect(isPossible.rookMove(chessboard, moveE4_H4)).toBeTruthy();
        Expect(isPossible.rookMove(chessboard, moveE4_A4)).toBeTruthy();
    }
}
Gerson Sunyé's avatar
Gerson Sunyé committed
203
204
205
206
----

==== Etape 2

207
208
Nouvelle fonctionnalité à implémenter: la validation des déplacements verticaux. 
Modifiez la fonction `rookMove()`:
Gerson Sunyé's avatar
Gerson Sunyé committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222

[source,ts]
----
// Dans le fichier "move-validation.ts"
export function rookMove(board: Chessboard, move: Move): boolean {
    return move.from.rank === move.to.rank || // Si les lignes de début de fin sont les mêmes, le déplacement est horizontal
        move.from.file === move.to.file;  // Si les colonnes de début de fin sont les mêmes, le déplacement est vertical
}
----

Écrivez ensuite un nouveau test unitaire pour cette nouvelle fonctionnalité:

[source,ts]
----
223
224
// Dans le fichier "rook-move-validation.spec.ts"
export class TestRocoMoves {
225
226
    // (...)

227
228
    @Test("A rook can move vertically")
    testCanMoveVertically() {
229
230
231
232
        Expect(isPossible.rookMove(chessboard, moveE4_E8)).toBeTruthy();
        Expect(isPossible.rookMove(chessboard, moveE4_E1)).toBeTruthy();
    }
}
Gerson Sunyé's avatar
Gerson Sunyé committed
233
234
235
236
237
238
239
240
241
242
243
244
245
246
----

==== Autres étapes

Suivez la même démarche pour implémenter et tester les autres fonctionnalités, c'est à dire, les autres mouvements possibles des tours.

=== Rendu

Vous allez pouvoir effectuer le rendu directement depuis l'interface de Gitlab, en réalisant ce qu'on appelle une *demande de fusion*.
Cela permet de nous envoyer tous les changements que vous avez effectué sur le projet en quelques clics.

. Assurez vous d'avoir effectué tous les _commits_ et _pushs_ nécessaires avec git.
. Dans le panneau de gauche, cliquez sur "Demandes de fusion".
. Cliquez sur "Nouvelle demande de fusion".
247
248
. Vérifiez que dans la partie droite on trouve bien `naomod/idl/projet-2019` et `master`.
. Dans la partie gauche, choisissez `<votre nom d'utilisateur>/projet-2019` (normalement déjà choisi) et également `master`.
Gerson Sunyé's avatar
Gerson Sunyé committed
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
. Cliquez sur "Compare branches and continue".
. Comme titre pour la demande de fusion, indiquez "Rendu NOM1 NOM2".
. Enfin, cliquez en bas sur "Submit demande de fusion"

Vous atteignez alors une page qui résume la demande effectuée.
Nous vous recommandons alors de cliquer sur l'onglet "_Changes_" afin d'avoir accès une une représentation visuelle de tous les changements que vous avez effectué.
Les lignes rouges indiques ce que vous avez retiré, les lignes vertes indiquent ce que vous avez ajouté.
Vérifiez si tout votre travail réalisé est bien présent sous la forme de lignes vertes.

Si vous le souhaitez, vous pouvez ajouter un fichier "`RENDU.md`" à la racine du projet, afin de décrire les spécificités de votre projet (choix techniques, parties non traitées, extensions non demandées, etc.).

=== Derniers conseils

* Rappelez-vous que « _Une fonction sans test unitaire ne fonctionne pas_ » !

* Rappelez-vous aussi que «*N'importe qui peut écrire du code compréhensible par les ordinateurs, mais seulement les bon développeurs parviennent à écrire du code intelligible par les humains* » !

* Écrivez les tests unitaires avant ou en même temps que les fonctions. Ne les laissez pas pour la fin, les test unitaires sont très utiles pendant le développement et vous feront gagner du temps.

* Faites bon usage de `git` : effectuez des _commits_ et des _pushs_ régulièrement ! Cela vous permet d'éviter de perdre votre travail, et de mieux collaborer en équipe.