Merge pull request #196 from aion-dk/QZ-419-blank-validations

Make blank validation based on new config in marking type

lib/av_client/types.ts

@@ -237,6 +237,7 @@ export type ContestConfig = {
 export type MarkingType = {
   minMarks: number
   maxMarks: number
+  blankSubmission: "disabled" | "active_choice" | "implicit"
   encoding: {
     codeSize: 1 | 2
     maxSize: number

lib/av_client/validate_selections.ts

@@ -22,15 +22,22 @@ export function validateContestSelection( contestConfig: ContestConfig, contestS
 
   const { markingType, options } = contestConfig
 
+  const isBlank = contestSelection.optionSelections.length === 0
+
+  // Validate blankSubmission
+  if( isBlank && markingType.blankSubmission == 'disabled'){
+    throw new CorruptSelectionError('Blank submissions are not allowed in this contest')
+  }
+
   // Validate that mark count is within bounds
-  if( !withinBounds(markingType.minMarks, contestSelection.optionSelections.length, markingType.maxMarks) ){
+  if( !isBlank && !withinBounds(markingType.minMarks, contestSelection.optionSelections.length, markingType.maxMarks) ){
     throw new CorruptSelectionError('Contest selection does not contain a valid amount of option selections')
-  } 
+  }
 
   // Validate duplicates - that any vote selection is not referencing the same option multiple times
   const selectedOptions = contestSelection.optionSelections.map(os => os.reference)
   if( hasDuplicates(selectedOptions) ){
-    throw new CorruptSelectionError('Same option slected multiple times')
+    throw new CorruptSelectionError('Same option selected multiple times')
   }
 
   const getOption = makeGetOption(options)

test/construct_contest_envelopes.test.ts

@@ -7,6 +7,7 @@ const contestOne: ContestConfig = {
   markingType: {
     minMarks: 1,
     maxMarks: 1,
+    blankSubmission: "disabled",
     encoding: {
       codeSize: 1,
       maxSize: 1,

test/decrypt_contest_selections.test.ts

@@ -10,6 +10,7 @@ const bigContest: ContestConfig = {
   markingType: {
     minMarks: 1,
     maxMarks: 1,
+    blankSubmission: "disabled",
     encoding: {
       codeSize: 1,
       maxSize: 41,

test/encoding/byte_encoding.test.ts

@@ -10,6 +10,7 @@ const contestConfig: ContestConfig = {
   markingType: {
     minMarks: 1,
     maxMarks: 3,
+    blankSubmission: "disabled",
     encoding: {
       codeSize: 1,
       maxSize: 20,

test/encrypt_contest_selections.test.ts

@@ -9,6 +9,7 @@ const contestOne: ContestConfig = {
   markingType: {
     minMarks: 1,
     maxMarks: 1,
+    blankSubmission: "disabled",
     encoding: {
       codeSize: 1,
       maxSize: 1,
@@ -67,6 +68,7 @@ describe('encryptContestSelections', () => {
       markingType: {
         minMarks: 1,
         maxMarks: 1,
+        blankSubmission: "disabled",
         encoding: {
           codeSize: 1,
           maxSize: 41,

test/replies/benaloh_flow/http_dbb_3003/get__us_configuration.json

@@ -39,6 +39,7 @@
         "markingType": {
           "minMarks": 1,
           "maxMarks": 1,
+          "blankSubmission": "disabled",
           "encoding": {
             "codeSize": 1,
             "maxSize": 1,
@@ -73,6 +74,7 @@
         "markingType": {
           "minMarks": 1,
           "maxMarks": 1,
+          "blankSubmission": "disabled",
           "encoding": {
             "codeSize": 1,
             "maxSize": 1,

test/replies/otp_flow/get_us_configuration.json

@@ -39,6 +39,7 @@
         "markingType": {
           "minMarks": 1,
           "maxMarks": 1,
+          "blankSubmission": "disabled",
           "encoding": {
             "codeSize": 1,
             "maxSize": 1,
@@ -73,6 +74,7 @@
         "markingType": {
           "minMarks": 1,
           "maxMarks": 1,
+          "blankSubmission": "disabled",
           "encoding": {
             "codeSize": 1,
             "maxSize": 1,

test/validate_selections.test.ts

@@ -8,6 +8,7 @@ const contestOne: ContestConfig = {
   markingType: {
     minMarks: 1,
     maxMarks: 1,
+    blankSubmission: "disabled",
     encoding: {
       codeSize: 1,
       maxSize: 1,
@@ -27,6 +28,13 @@ const contestOne: ContestConfig = {
       title: { en: 'Option 1' },
       subtitle: { en: 'Option 1' },
       description: { en: 'Option 1' },
+    },
+    {
+      reference: 'option-3',
+      code: 3,
+      title: { en: 'Option 3' },
+      subtitle: { en: 'Option 3' },
+      description: { en: 'Option 3' },
     }
   ]
 }
@@ -36,6 +44,7 @@ const contestTwo: ContestConfig = {
   markingType: {
     minMarks: 1,
     maxMarks: 2,
+    blankSubmission: "active_choice",
     encoding: {
       codeSize: 1,
       maxSize: 2,
@@ -81,33 +90,46 @@ describe('validateContestSelection', () => {
         { reference: 'option-1' }
       ]
     }
-    it('does not throw error', () => {
+    it('throws an error', () => {
       expect(() => {
         validateContestSelection( contestOne, contestSelection )
       }).to.throw(CorruptSelectionError, 'Contest selection is not matching contest config')
     })
   })
 
-  context('when given a contest selection with no selections', () => {
+  context('when given a contest selection with no selections and blank disabled', () => {
     const contestSelection = {
-      reference: 'contest-2',
+      reference: 'contest-1',
       optionSelections: []
     }
-    it('does not throw error', () => {
+    it('throws an error', () => {
       expect(() => {
-        validateContestSelection( contestTwo, contestSelection )
-      }).to.throw(CorruptSelectionError, 'Contest selection does not contain a valid amount of option selections')
+        validateContestSelection( contestOne, contestSelection )
+      }).to.throw(CorruptSelectionError, 'Blank submissions are not allowed in this contest')
     })
   })
 
-  context('when given a contest selection with two selections', () => {
+  context('when given a contest selection with no selections and blank enabled', () => {
     const contestSelection = {
       reference: 'contest-2',
       optionSelections: []
     }
-    it('does not throw error', () => {
+    it('does not throw an error', () => {
       expect(() => {
         validateContestSelection( contestTwo, contestSelection )
+      }).to.not.throw()
+    })
+  })
+
+  context('when given a contest selection with two selections', () => {
+    const contestSelection = {
+      reference: 'contest-1',
+      optionSelections: [{ reference: 'option-1' },
+        { reference: 'option-3' }]
+    }
+    it('throws an error', () => {
+      expect(() => {
+        validateContestSelection( contestOne, contestSelection )
       }).to.throw(CorruptSelectionError, 'Contest selection does not contain a valid amount of option selections')
     })
   })
@@ -119,7 +141,7 @@ describe('validateContestSelection', () => {
         { reference: 'option-2' }
       ]
     }
-    it('does not throw error', () => {
+    it('throws an error', () => {
       expect(() => {
         validateContestSelection( contestOne, contestSelection )
       }).to.throw(CorruptSelectionError, 'Option config not found')
@@ -136,10 +158,10 @@ describe('validateContestSelection', () => {
           { reference: 'option-a' }
         ]
       }
-      it('does not throw error', () => {
+      it('throws an error', () => {
         expect(() => {
           validateContestSelection( contestTwo, contestSelection )
-        }).to.throw(CorruptSelectionError, 'Same option slected multiple times')
+        }).to.throw(CorruptSelectionError, 'Same option selected multiple times')
       })
     })
   })

test/verifier/readable_contest_selections.test.ts

@@ -10,6 +10,7 @@ const contestConfigs: ContestConfigMap = {
     "markingType": {
       "minMarks": 1,
       "maxMarks": 1,
+      "blankSubmission": "disabled",
       "encoding": {
         "codeSize": 1,
         "maxSize": 1,
@@ -50,6 +51,7 @@ const contestConfigs: ContestConfigMap = {
     "markingType": {
       "minMarks": 1,
       "maxMarks": 1,
+      "blankSubmission": "disabled",
       "encoding": {
         "codeSize": 1,
         "maxSize": 1,