- fix bug in password reset.

- new information question in the demo suggesting use of yamllint. - version bump to 2020.05.dev3

- fix bug in password reset.
- new information question in the demo suggesting use of yamllint. - version bump to 2020.05.dev3
Miguel Barão
1 parent be82c164
Showing 10 changed files with 55 additions and 34 deletions Show diff stats
BUGS.md
demo/demo.yaml
demo/questions/generators/generate-question.py
demo/questions/questions-tutorial.yaml
perguntations/__init__.py
perguntations/app.py
perguntations/models.py
perguntations/serve.py
perguntations/templates/review-question-information.html
perguntations/templates/review-question.html
 # BUGS
-- review does not show question refs when commandline --show-ref is used but not the test.yaml option.
-- em admin, quando scale_max não é 20, as cores das barras continuam a reflectir a escala 0,20. a tabela teste na DB não tem a escala desse teste.
 - CRITICAL se answer for `i<n` a revisão de provas mostra apenas i (interpreta `<` como tag?)
-- na pagina grade.html as barras estao normalizadas para os limites scale_min e max do teste actual e nao do realizado.
+
+- em admin, quando scale_max não é 20, as cores das barras continuam a reflectir a escala 0,20. a tabela teste na DB não tem a escala desse teste.
+- em grade.html as barras estao normalizadas para os limites scale_min e max do teste actual e nao dos testes realizados no passado (tabela test devia guardar a escala).
 - codigo `hello   world` nao esta a preservar o whitespace. O renderer de markdown gera a tag <code> que não preserva whitespace. Necessario adicionar <pre>.
-- teste nao esta a mostrar imagens de vez em quando.
 - mensagems de erro do assembler aparecem na mesma linha na correcao e nao fazerm rendering do `$t`, ver se servidor faz parse do markdown dessas mensagens.
 - impedir os eventos copy/paste. alunos usam isso para trazer codigo ja feito nos computadores. Obrigar a fazer reset? fazer um copy automaticamente?
 - a revisao do teste não mostra as imagens.
 - Test.reset_answers() unused.
-- incluir test_id na tabela questions (futuro semestre, pode quebrar compatibilidade).
-- na pagina admin, mostrar com cor vermelha as horas de entrada dos alunos que ja tenham excedido o tempo
+- teste nao esta a mostrar imagens de vez em quando.???
 # TODO
+- na pagina admin, mostrar com cor vermelha as horas de entrada dos alunos que ja tenham excedido o tempo
 - retornar None quando nao ha alteracoes relativamente à última vez.
 ou usar push (websockets?)
 - mudar ref do test para test_id (ref já é usado nas perguntas)
 ---
 # ============================================================================
 # Unique identifier of the test.
+# Valid names can only include letters, digits, dash and underscore,
+# e.g.  asc1-test3
 # Database queries can be done in the terminal with
-#     sqlite3 students.db "select * from tests where ref='tutorial'"
+#     sqlite3 students.db "select * from tests where ref='asc1-test3'"
 ref: tutorial
 # Database file that includes student credentials, tests and questions grades.
@@ -20,9 +22,9 @@ title: Teste de demonstração (tutorial)
 # Duration in minutes.
 # (0 or undefined means infinite time)
-duration: 2
+duration: 0
-# Automatic test submission after the timeout 'duration'?
+# Automatic test submission after the given 'duration' timeout
 # (default: false)
 autosubmit: true
@@ -40,9 +42,6 @@ scale: [0, 5]
 # scale_min: 0
 # scale_points: true
-show_ref: true
-debug: false
-
 # ----------------------------------------------------------------------------
 # Base path applied to the questions files and all the scripts
 # including question generators and correctors.
@@ -75,7 +74,7 @@ questions:
   - tut-warning
   - [tut-alert1, tut-alert2]
   - tut-generator
-
+  - tut-yamllint
 # test:
 #   - ref1
@@ -18,11 +18,10 @@ print(f&quot;&quot;&quot;---
 type: text
 title: Geradores de perguntas
 text: |
-  Existe a possibilidade da pergunta ser gerada por um programa externo. Este
-  programa deve escrever no `stdout` uma pergunta em formato `yaml` como nos
+  Existe a possibilidade da pergunta ser gerada por um programa externo. O
+  programa deve escrever no `stdout` uma pergunta em formato `yaml` tal como os
   exemplos anteriores. Pode também receber argumentos para parametrizar a
-  geração da pergunta. Aqui está um exemplo de uma pergunta gerada por um
-  script python:
+  pergunta. Aqui está um exemplo de uma pergunta gerada por um script python:
   ```python
       #!/usr/bin/env python3
@@ -46,9 +45,7 @@ text: |
         A solução é {{r}}.''')
   ```
-  Este script deve ter permissões para poder ser executado no terminal. Dá
-  jeito usar o comando `gen-somar.py 1 100 | yamllint -` para validar o `yaml`
-  gerado.
+  Este script deve ter permissões para poder ser executado no terminal.
   Para indicar que uma pergunta é gerada externamente, esta é declarada com
@@ -56,12 +53,12 @@ text: |
       - type: generator
         ref: gen-somar
         script: gen-somar.py
-        # opcional
+        # argumentos opcionais
         args: [1, 100]
   ```
-  Os argumentos `args` são opcionais e são passados para o programa como
-  argumentos da linha de comando.
+  Opcionalmente, o programa pode receber uma lista de argumentos declarados em
+  `args`.
   ---
@@ -581,3 +581,25 @@
   ref: tut-generator
   script: generators/generate-question.py
   args: [1, 100]
+
+# ----------------------------------------------------------------------------
+- type: information
+  ref: tut-yamllint
+  title: Sugestões para validar yaml
+  text: |
+    Como os testes e perguntas são ficheiros `yaml`, é conveniente validar se
+    estão correctamente definitos. Um *linter* recomendado é o `yamllint`. Pode
+    ser instalado com `pip install yamllint` e usado do seguinte modo:
+
+    ```sh
+        yamllint test.yaml
+        yamllint questions.yaml
+    ```
+
+    No caso de programas geradores de perguntas e programas de correcção de
+    respostas pode usar-se um *pipe*:
+
+    ```sh
+        generate-question | yamllint -
+        correct-answer | yamllint -
+    ```
@@ -32,7 +32,7 @@ proof of submission and for review.
 '''
 APP_NAME = 'perguntations'
-APP_VERSION = '2020.05.dev2'
+APP_VERSION = '2020.05.dev3'
 APP_DESCRIPTION = __doc__
 __author__ = 'Miguel Barão'
@@ -276,8 +276,9 @@ class App():
                         uid, area, win_x, win_y, scr_x, scr_y)
     # ------------------------------------------------------------------------
+    # --- GETTERS
+    # ------------------------------------------------------------------------
-    # --- helpers (getters)
     # def get_student_name(self, uid):
     #     return self.online[uid]['student']['name']
@@ -388,7 +389,10 @@ class App():
     #         if q['ref'] == ref and key in q['files']:
     #             return path.abspath(path.join(q['path'], q['files'][key]))
-    # --- helpers (change state)
+    # ------------------------------------------------------------------------
+    # --- SETTERS
+    # ------------------------------------------------------------------------
+
     def allow_student(self, uid):
         '''allow a single student to login'''
         self.allowed.add(uid)
@@ -90,5 +90,5 @@ class Question(Base):
                 f'  grade:      "{self.grade}"\n'
                 f'  starttime:  "{self.starttime}"\n'
                 f'  finishtime: "{self.finishtime}"\n'
-                f'  student_id: "{self.student_id}"\n'
+                f'  student_id: "{self.student_id}"\n'  # FIXME normal form
                 f'  test_id:    "{self.test_id}"\n')
@@ -246,7 +246,7 @@ class AdminHandler(BaseHandler):
             self.testapp.deny_student(value)
         elif cmd == 'reset_password':
-            await self.testapp.update_student_password(uid=value, pw='')
+            await self.testapp.update_student_password(uid=value, password='')
         elif cmd == 'insert_student':
             student = json.loads(value)
@@ -18,7 +18,7 @@
 	</div>
     {% if t['show_ref'] %}
         <hr>
-        File: <code>{{ q['path'] }}/{{ q['filename'] }}</code>,
-        Ref: <code>{{ q['ref'] }}</code>
+        file: <code>{{ q['path'] }}/{{ q['filename'] }}</code><br>
+        ref:  <code>{{ q['ref'] }}</code>
     {% end %}
 </div>
 \ No newline at end of file
@@ -66,8 +66,8 @@
         {% if t['show_ref'] %}
           <hr>
-          File: <code>{{ q['path'] }}/{{ q['filename'] }}</code>,
-          Ref: <code>{{ q['ref'] }}</code>
+          file: <code>{{ q['path'] }}/{{ q['filename'] }}</code><br>
+          ref:  <code>{{ q['ref'] }}</code>
         {% end %}
       </div> <!-- card-footer -->
@@ -110,8 +110,8 @@
         {% if t['show_ref'] %}
           <hr>
-          File: <code>{{ q['path'] }}/{{ q['filename'] }}</code>,
-          Ref: <code>{{ q['ref'] }}</code>
+          file: <code>{{ q['path'] }}/{{ q['filename'] }}</code><br>
+          ref:  <code>{{ q['ref'] }}</code>
         {% end %}
       </div> <!-- card-footer -->
	@@ -581,3 +581,25 @@		@@ -581,3 +581,25 @@
581	ref: tut-generator	581	ref: tut-generator
582	script: generators/generate-question.py	582	script: generators/generate-question.py
583	args: [1, 100]	583	args: [1, 100]
		584	+
		585	+# ----------------------------------------------------------------------------
		586	+- type: information
		587	+ ref: tut-yamllint
		588	+ title: Sugestões para validar yaml
		589	+ text: \|
		590	+ Como os testes e perguntas são ficheiros `yaml`, é conveniente validar se
		591	+ estão correctamente definitos. Um linter recomendado é o `yamllint`. Pode
		592	+ ser instalado com `pip install yamllint` e usado do seguinte modo:
		593	+
		594	+ ```sh
		595	+ yamllint test.yaml
		596	+ yamllint questions.yaml
		597	+ ```
		598	+
		599	+ No caso de programas geradores de perguntas e programas de correcção de
		600	+ respostas pode usar-se um pipe:
		601	+
		602	+ ```sh
		603	+ generate-question \| yamllint -
		604	+ correct-answer \| yamllint -
		605	+ ```
	@@ -32,7 +32,7 @@ proof of submission and for review.		@@ -32,7 +32,7 @@ proof of submission and for review.
32	'''	32	'''
33		33
34	APP_NAME = 'perguntations'	34	APP_NAME = 'perguntations'
35	-APP_VERSION = '2020.05.dev2'	35	+APP_VERSION = '2020.05.dev3'
36	APP_DESCRIPTION = __doc__	36	APP_DESCRIPTION = __doc__
37		37
38	__author__ = 'Miguel Barão'	38	__author__ = 'Miguel Barão'
	@@ -90,5 +90,5 @@ class Question(Base):		@@ -90,5 +90,5 @@ class Question(Base):
90	f' grade: "{self.grade}"\n'	90	f' grade: "{self.grade}"\n'
91	f' starttime: "{self.starttime}"\n'	91	f' starttime: "{self.starttime}"\n'
92	f' finishtime: "{self.finishtime}"\n'	92	f' finishtime: "{self.finishtime}"\n'
93	- f' student_id: "{self.student_id}"\n'	93	+ f' student_id: "{self.student_id}"\n' # FIXME normal form
94	f' test_id: "{self.test_id}"\n')	94	f' test_id: "{self.test_id}"\n')
	@@ -246,7 +246,7 @@ class AdminHandler(BaseHandler):		@@ -246,7 +246,7 @@ class AdminHandler(BaseHandler):
246	self.testapp.deny_student(value)	246	self.testapp.deny_student(value)
247		247
248	elif cmd == 'reset_password':	248	elif cmd == 'reset_password':
249	- await self.testapp.update_student_password(uid=value, pw='')	249	+ await self.testapp.update_student_password(uid=value, password='')
250		250
251	elif cmd == 'insert_student':	251	elif cmd == 'insert_student':
252	student = json.loads(value)	252	student = json.loads(value)