Merge pull request 'add badge for passing builds' (!51) from feature/add-badge-for-builds into develop

Reviewed-on: https://gitea.e5tv.hu/esoko/mapguesser/pulls/51

Jenkinsfile

@@ -0,0 +1,59 @@
+pipeline {
+    agent {
+        node {
+            label 'mapguesser'
+            customWorkspace 'workspace/mapguesser'
+        }
+    }
+
+    stages {
+        stage('Install composer') {
+            agent {
+                dockerfile {
+                    filename 'docker/Dockerfile-test'
+                    dir '.'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'composer install'
+            }
+        }
+
+        stage('Unit Testing') {
+            agent {
+                dockerfile {
+                    filename 'docker/Dockerfile-test'
+                    dir '.'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'vendor/bin/phpunit --log-junit unit_test_results.xml --testdox tests'
+            }
+            post {
+                success {
+                    archiveArtifacts 'unit_test_results.xml'
+                }
+            }
+        }
+
+        stage('Static Code Analysis') {
+            agent {
+                dockerfile {
+                    filename 'docker/Dockerfile-test'
+                    dir '.'
+                    reuseNode true
+                }
+            }
+            steps {
+                sh 'php -d memory_limit=1G vendor/bin/phpstan analyse -c phpstan.neon --error-format=prettyJson > static_code_analysis_results.json'
+            }
+            post {
+                success {
+                    archiveArtifacts 'static_code_analysis_results.json'
+                }
+            }
+        }
+    }
+}

README.md

@@ -1,5 +1,7 @@
 # MapGuesser
 
+[![Build Status](https://jenkins.e5tv.hu/job/mapguesser/job/develop/badge/icon)](https://jenkins.e5tv.hu/job/mapguesser/job/develop/)
+
 This is the MapGuesser Application project. This is a game about guessing where you are based on a street view panorama - inspired by existing applications.
 
 ## Installation

docker/Dockerfile-test

@@ -0,0 +1,4 @@
+FROM php:7.4.7-cli-buster
+
+RUN apt-get update && apt-get install -y unzip
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

public/static/css/mapguesser.css

@@ -31,11 +31,11 @@ main {
     color: #ffffff;
 }
 
-p, h1, h2, input, textarea, select, button, a, table {
+p, h1, h2, h3, input, textarea, select, button, a, table, label {
     font-family: 'Roboto', sans-serif;
 }
 
-h1, h2 {
+h1, h2, h3 {
     font-weight: 500;
 }
 
@@ -55,7 +55,11 @@ h2, header.small h1 {
     font-size: 24px;
 }
 
-p, h2 {
+h3 {
+    font-size: 18px;
+}
+
+p, h2, h3 {
     line-height: 150%;
 }
 

public/static/css/maps.css

@@ -75,16 +75,6 @@ div.mapItem>div.buttonContainer {
     grid-auto-flow: column;
 }
 
-#restrictions {
-    margin-top: 1em;
-    margin-bottom: 1em;
-    font-family: 'Roboto', sans-serif;
-}
-
-#restrictions h3 {
-    font-weight: 500;
-}
-
 #restrictions input {
     height: auto;
     margin: 0.5em;

public/static/js/game.js

@@ -21,7 +21,6 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
         googleLink: null,
         history: [],
         restrictions: null,
-        finishers: null,
 
         readyToContinue: true,
         timeoutEnd: null,
@@ -348,8 +347,6 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
                 return;
             }
 
-            
-
             var restrictionsForDisplay = [];
             if (Game.restrictions.timeLimit) {
                 restrictionsForDisplay.push('time limit per ' + Game.restrictions.timeLimitType);
@@ -366,6 +363,10 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
                 }
             }
 
+            if (restrictionsForDisplay.length == 0) {
+                return;
+            }
+
             // create restrictions span for header
             var restrictions = document.createElement('span');
             restrictions.setAttribute('id', 'restrictions');
@@ -397,7 +398,7 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
             Game.timeoutEnd = null;
         },
 
-        hideRestrictions: function() {
+        hideRestrictions: function () {
             var restrictions = document.getElementById('restrictions');
             if (restrictions) {
                 var header = restrictions.parentNode;
@@ -486,10 +487,6 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
                     }
                 }
             }
-
-            if (response.finishers) {
-                Game.finishers = new Set(response.finishers);
-            }
         },
 
         reset: function () {
@@ -542,7 +539,6 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
             document.getElementById('panningBlockerCover').style.display = null;
 
             Game.history = [];
-            Game.finishers = null;
 
             Game.initialize();
         },
@@ -871,16 +867,21 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
             var highscores = new Map();
             highscores.set('me', Game.scoreSum);
 
-            for (var i = 0; i < Game.history.length; ++i) {
+            // collect the results of users who are through the last round
+            const round = Game.history[Game.history.length - 1];
+            if (round.allResults) {
+                for (const result of round.allResults) {
+                    highscores.set(result.userName, result.score);
+                }
+            }
+
+            // add up scores only for the finishers
+            for (var i = Game.history.length - 2; i >= 0; --i) {
                 const round = Game.history[i];
                 if (round.allResults) {
                     for (const result of round.allResults) {
-                        if (Game.finishers.has(result.userName)) {
-                            if (highscores.has(result.userName)) {
-                                highscores.set(result.userName, highscores.get(result.userName) + result.score);
-                            } else {
-                                highscores.set(result.userName, result.score);
-                            }
+                        if (highscores.has(result.userName)) {
+                            highscores.set(result.userName, highscores.get(result.userName) + result.score);
                         }
                     }
                 }
@@ -955,7 +956,7 @@ const GameType = Object.freeze({ 'SINGLE': 0, 'MULTI': 1, 'CHALLENGE': 2 });
 
         },
 
-        showHighscores: function() {
+        showHighscores: function () {
 
             if (Game.type == GameType.CHALLENGE) {
                 var highscores = this.calculateHighScores();

src/Controller/GameController.php

@@ -112,11 +112,10 @@ class GameController implements ISecured
     public function createNewChallenge(): IContent
     {
         // create Challenge
-        $challengeToken = rand();
-        while ($this->challengeRepository->getByToken($challengeToken)) {
-            // if a challenge with the same token already exists
-            $challengeToken = rand();
-        }
+        do {
+            // initiliaze or if a challenge with the same token already exists
+            $challengeToken = mt_rand();
+        } while ($this->challengeRepository->getByToken($challengeToken));
 
         $challenge = new Challenge();
         $challenge->setToken($challengeToken);
@@ -208,7 +207,7 @@ class GameController implements ISecured
 
         $room = $this->multiRoomRepository->getByRoomId($roomId);
 
-        if(!isset($room)) {
+        if (!isset($room)) {
             return new JsonContent(['error' => 'game_not_found']);
         }
 
@@ -265,7 +264,7 @@ class GameController implements ISecured
             return new JsonContent(['error' => 'game_not_found']);
         }
 
-        if(!$this->userInChallengeRepository->isUserParticipatingInChallenge($userId, $challenge)) {
+        if (!$this->userInChallengeRepository->isUserParticipatingInChallenge($userId, $challenge)) {
             // new player is joining
             $userInChallenge = new UserInChallenge();
             $userInChallenge->setUserId($userId);

src/Controller/GameFlowController.php

@@ -199,14 +199,6 @@ class GameFlowController implements ISecured
 
         if (!isset($currentPlace)) { // game finished
             $response['finished'] = true;
-
-            // list all players who finished the challenge
-            $response['finishers'] = [];
-            foreach ($this->userInChallengeRepository->getAllByChallengeWithUsers($challenge) as $userInChallenge) {
-                if ($userInChallenge->getCurrentRound() == $currentRound && $userInChallenge->getUser()->getId() != $userId) {
-                    $response['finishers'][] = $userInChallenge->getUser()->getDisplayName();
-                }
-            }
         } else { // continue game
             $response['place'] = [
                 'panoId' => $currentPlace->getPanoIdCached(),
@@ -309,9 +301,9 @@ class GameFlowController implements ISecured
         $session = $this->request->session();
         $userId = $session->get('userId');
 
-        if(isset($userId)) {
+        if (isset($userId)) {
             $userPlayedPlace = $this->userPlayedPlaceRepository->getByUserIdAndPlaceId($userId, $placeId);
-            if(!$userPlayedPlace) {
+            if (!$userPlayedPlace) {
                 $userPlayedPlace = new UserPlayedPlace();
                 $userPlayedPlace->setUserId($userId);
                 $userPlayedPlace->setPlaceId($placeId);
@@ -415,7 +407,7 @@ class GameFlowController implements ISecured
             $response['restrictions']['timeLimit'] = $timeLimit * 1000;
         }
 
-        if(isset($response['history'][$currentRound]['allResults'])) {
+        if (isset($response['history'][$currentRound]['allResults'])) {
             $response['allResults'] = $response['history'][$currentRound]['allResults'];
         }
 

src/Controller/MapAdminController.php

@@ -8,6 +8,7 @@ use MapGuesser\Interfaces\Response\IContent;
 use MapGuesser\PersistentData\Model\Challenge;
 use MapGuesser\PersistentData\Model\Map;
 use MapGuesser\PersistentData\Model\Place;
+use MapGuesser\PersistentData\Model\PlaceInChallenge;
 use MapGuesser\PersistentData\PersistentDataManager;
 use MapGuesser\Repository\ChallengeRepository;
 use MapGuesser\Repository\GuessRepository;

src/Database/Query/Select.php

@@ -261,7 +261,7 @@ class Select
             $queryString .= ' LIMIT ' . $this->limit[1] . ', ' . $this->limit[0];
         }
 
-        if($this->isDerivedTable()) {
+        if ($this->isDerivedTable()) {
             $queryString = '(' . $queryString . ') AS ' . $this->tableAliases[Select::DERIVED_TABLE_KEY];
         }
 
@@ -276,7 +276,7 @@ class Select
             return [(string) $table, $params];
         }
 
-        if($table instanceof Select)
+        if ($table instanceof Select)
         {
             return $table->generateQuery();
         }
@@ -332,7 +332,7 @@ class Select
         $joinQueries = [];
         $params = [];
 
-        foreach($this->joins as $join) {
+        foreach ($this->joins as $join) {
             list($joinQueryFragment, $paramsFragment) = $this->generateTable($join[1], true);
             $joinQueries[] = $join[0] . ' JOIN ' . $joinQueryFragment . ' ON ' . $this->generateColumn($join[2]) . ' ' . $join[3] . ' ' . $this->generateColumn($join[4]);
             $params = array_merge($params, $paramsFragment);

src/PersistentData/Model/Challenge.php

@@ -33,7 +33,7 @@ class Challenge extends Model
 
     public function setTimeLimit(?int $timeLimit): void
     {
-        if(isset($timeLimit)) {
+        if (isset($timeLimit)) {
             $this->timeLimit = $timeLimit;
         }
     }

src/PersistentData/Model/UserInChallenge.php

@@ -49,7 +49,7 @@ class UserInChallenge extends Model
 
     public function setTimeLeft(?int $timeLeft): void
     {
-        if(isset($timeLeft)) {
+        if (isset($timeLeft)) {
             $this->timeLeft = max(0, $timeLeft);
         }
     }

src/Repository/UserInChallengeRepository.php

@@ -57,10 +57,8 @@ class UserInChallengeRepository
         }
 
         // validate token string
-        foreach (str_split($token_str) as $char) {
-            if (!(('0' <= $char && $char <= '9') || ('a' <= $char && $char <= 'f'))) {
-                return null;
-            }
+        if (!ctype_xdigit($token_str)) {
+            return null;
         }
         // convert token to int
         $token = hexdec($token_str);
@@ -78,6 +76,6 @@ class UserInChallengeRepository
         $select->where('user_id', '=', $userId);
         $select->where('challenge_id', '=', $challenge->getId());
 
-        return $select->count();
+        return $select->count() != 0;
     }
 }

views/game.php

@@ -30,7 +30,7 @@
 
 @section(subheader)
     <span id="mapName" class="bold">Loading map...</span><!--
- --><span>Round <span id="currentRound" class="bold"></span></span><!--
+ --><span id="roundContainer">Round <span id="currentRound" class="bold"></span></span><!--
  --><span>Score <span id="currentScoreSum" class="bold"></span></span>
 @endsection
 

views/maps.php

@@ -43,7 +43,7 @@ TODO: condition!
         <p class="bold center marginTop marginBottom">OR</p>
         -->
         
-        <div id="restrictions">
+        <div id="restrictions" class="marginTop marginBottom">
             <h3>Optional restrictions</h3>
             <div>
                 <div>
@@ -54,7 +54,7 @@ TODO: condition!
                     <input type="range" id="timeLimit" name="timeLimit" min="10" max="1800" step="10" value="300" />
                 </div>
                 <div id="timeLimitType">
-                    Time limit
+                    <label>Time limit</label>
                     <input type="radio" id="timeLimitTypeGame" name="timeLimitType" value="game" checked />
                     <label for="timeLimitTypeGame">for the whole game</label>
                     <input type="radio" id="timeLimitTypeRound" name="timeLimitType" value="round" />
@@ -67,7 +67,7 @@ TODO: condition!
             </div>
             <div>
                 <input type="checkbox" id="noZoom" name="noZoom" value="noZoom" />
-                <label for="noMove">No zoom allowed</label>
+                <label for="noZoom">No zoom allowed</label>
             </div>
             <div>
                 <input type="checkbox" id="noPan" name="noPan" value="noPan" />