Merge pull request #51 from c4dt/316

fix: repair JSON export
c4dt · Nov 24, 2023 · 7f8c477 · 7f8c477
2 parents ea49694 + 97b98be
commit 7f8c477
Show file tree

Hide file tree

Showing 35 changed files with 468 additions and 471 deletions.
diff --git a/contracts/evoting/controller/action.go b/contracts/evoting/controller/action.go
@@ -445,7 +445,7 @@ func (a *scenarioTestAction) Execute(ctx node.Context) error {
 		return xerrors.Errorf(getFormErr, err)
 	}
 
-	dela.Logger.Info().Msg("Title of the form: " + form.Configuration.MainTitle)
+	dela.Logger.Info().Msg("Title of the form: " + form.Configuration.Title.En)
 	dela.Logger.Info().Msg("Status of the form: " + strconv.Itoa(int(form.Status)))
 
 	// ###################################### SHUFFLE BALLOTS ##################
@@ -642,15 +642,15 @@ func setupSimpleForm(ctx node.Context, secret kyber.Scalar, proxyAddr1 string,
 		return "", types.Form{}, nil, xerrors.Errorf("formID mismatch: %s != %s", form.FormID, formID)
 	}
 
-	fmt.Fprintf(ctx.Out, "Title of the form: "+form.Configuration.MainTitle)
+	fmt.Fprintf(ctx.Out, "Title of the form: "+form.Configuration.Title.En)
 	fmt.Fprintf(ctx.Out, "ID of the form: "+form.FormID)
 	fmt.Fprintf(ctx.Out, "Status of the form: "+strconv.Itoa(int(form.Status)))
 
 	return formID, form, formIDBuf, nil
 }
 
 func logFormStatus(form types.Form) {
-	dela.Logger.Info().Msg("Title of the form : " + form.Configuration.MainTitle)
+	dela.Logger.Info().Msg("Title of the form : " + form.Configuration.Title.En)
 	dela.Logger.Info().Msg("ID of the form : " + form.FormID)
 	dela.Logger.Info().Msg("Status of the form : " + strconv.Itoa(int(form.Status)))
 }

diff --git a/contracts/evoting/types/ballots.go b/contracts/evoting/types/ballots.go
@@ -253,12 +253,26 @@ func (b *Ballot) Equal(other Ballot) bool {
 	return true
 }
 
+// Title contains the titles in different languages.
+type Title struct {
+	En string
+	Fr string
+	De string
+}
+
+// Hint contains explanations in different languages.
+type Hint struct {
+	En string
+	Fr string
+	De string
+}
+
 // Subject is a wrapper around multiple questions that can be of type "select",
 // "rank", or "text".
 type Subject struct {
 	ID ID
 
-	Title string
+	Title Title
 
 	// Order defines the order of the different question, which all have a unique
 	// identifier. This is purely for display purpose.
@@ -414,11 +428,11 @@ func isValid(q Question) bool {
 type Select struct {
 	ID ID
 
-	Title   string
+	Title   Title
 	MaxN    uint
 	MinN    uint
 	Choices []string
-	Hint    string
+	Hint    Hint
 }
 
 // GetID implements Question
@@ -480,11 +494,11 @@ func (s Select) unmarshalAnswers(sforms []string) ([]bool, error) {
 type Rank struct {
 	ID ID
 
-	Title   string
+	Title   Title
 	MaxN    uint
 	MinN    uint
 	Choices []string
-	Hint    string
+	Hint    Hint
 }
 
 func (r Rank) GetID() string {
@@ -553,13 +567,13 @@ func (r Rank) unmarshalAnswers(ranks []string) ([]int8, error) {
 type Text struct {
 	ID ID
 
-	Title     string
+	Title     Title
 	MaxN      uint
 	MinN      uint
 	MaxLength uint
 	Regex     string
 	Choices   []string
-	Hint      string
+	Hint      Hint
 }
 
 func (t Text) GetID() string {

diff --git a/contracts/evoting/types/ballots_test.go b/contracts/evoting/types/ballots_test.go
@@ -56,29 +56,29 @@ func TestBallot_Unmarshal(t *testing.T) {
 
 		Selects: []Select{{
 			ID:      decodedQuestionID(1),
-			Title:   "",
+			Title:   Title{En: "", Fr: "", De: ""},
 			MaxN:    2,
 			MinN:    2,
 			Choices: make([]string, 3),
 		}, {
 			ID:      decodedQuestionID(2),
-			Title:   "",
+			Title:   Title{En: "", Fr: "", De: ""},
 			MaxN:    3,
 			MinN:    3,
 			Choices: make([]string, 5),
 		}},
 
 		Ranks: []Rank{{
 			ID:      decodedQuestionID(3),
-			Title:   "",
+			Title:   Title{En: "", Fr: "", De: ""},
 			MaxN:    4,
 			MinN:    0,
 			Choices: make([]string, 4),
 		}},
 
 		Texts: []Text{{
 			ID:        decodedQuestionID(4),
-			Title:     "",
+			Title:     Title{En: "", Fr: "", De: ""},
 			MaxN:      2,
 			MinN:      2,
 			MaxLength: 10,
@@ -305,7 +305,7 @@ func TestSubject_MaxEncodedSize(t *testing.T) {
 	subject := Subject{
 		Subjects: []Subject{{
 			ID:       "",
-			Title:    "",
+			Title:    Title{En: "", Fr: "", De: ""},
 			Order:    nil,
 			Subjects: []Subject{},
 			Selects:  []Select{},
@@ -315,37 +315,37 @@ func TestSubject_MaxEncodedSize(t *testing.T) {
 
 		Selects: []Select{{
 			ID:      encodedQuestionID(1),
-			Title:   "",
+			Title:   Title{En: "", Fr: "", De: ""},
 			MaxN:    3,
 			MinN:    0,
 			Choices: make([]string, 3),
 		}, {
 			ID:      encodedQuestionID(2),
-			Title:   "",
+			Title:   Title{En: "", Fr: "", De: ""},
 			MaxN:    5,
 			MinN:    0,
 			Choices: make([]string, 5),
 		}},
 
 		Ranks: []Rank{{
 			ID:      encodedQuestionID(3),
-			Title:   "",
+			Title:   Title{En: "", Fr: "", De: ""},
 			MaxN:    4,
 			MinN:    0,
 			Choices: make([]string, 4),
 		}},
 
 		Texts: []Text{{
 			ID:        encodedQuestionID(4),
-			Title:     "",
+			Title:     Title{En: "", Fr: "", De: ""},
 			MaxN:      2,
 			MinN:      0,
 			MaxLength: 10,
 			Regex:     "",
 			Choices:   make([]string, 2),
 		}, {
 			ID:        encodedQuestionID(5),
-			Title:     "",
+			Title:     Title{En: "", Fr: "", De: ""},
 			MaxN:      1,
 			MinN:      0,
 			MaxLength: 10,
@@ -355,8 +355,8 @@ func TestSubject_MaxEncodedSize(t *testing.T) {
 	}
 
 	conf := Configuration{
-		MainTitle: "",
-		Scaffold:  []Subject{subject},
+		Title:    Title{En: "", Fr: "", De: ""},
+		Scaffold: []Subject{subject},
 	}
 
 	size := conf.MaxBallotSize()
@@ -368,7 +368,7 @@ func TestSubject_MaxEncodedSize(t *testing.T) {
 func TestSubject_IsValid(t *testing.T) {
 	mainSubject := &Subject{
 		ID:       ID(base64.StdEncoding.EncodeToString([]byte("S1"))),
-		Title:    "",
+		Title:    Title{En: "", Fr: "", De: ""},
 		Order:    []ID{},
 		Subjects: []Subject{},
 		Selects:  []Select{},
@@ -378,7 +378,7 @@ func TestSubject_IsValid(t *testing.T) {
 
 	subSubject := &Subject{
 		ID:       ID(base64.StdEncoding.EncodeToString([]byte("S2"))),
-		Title:    "",
+		Title:    Title{En: "", Fr: "", De: ""},
 		Order:    []ID{},
 		Subjects: []Subject{},
 		Selects:  []Select{},
@@ -387,8 +387,8 @@ func TestSubject_IsValid(t *testing.T) {
 	}
 
 	configuration := Configuration{
-		MainTitle: "",
-		Scaffold:  []Subject{*mainSubject, *subSubject},
+		Title:    Title{En: "", Fr: "", De: ""},
+		Scaffold: []Subject{*mainSubject, *subSubject},
 	}
 
 	valid := configuration.IsValid()
@@ -400,15 +400,15 @@ func TestSubject_IsValid(t *testing.T) {
 
 	mainSubject.Selects = []Select{{
 		ID:      encodedQuestionID(1),
-		Title:   "",
+		Title:   Title{En: "", Fr: "", De: ""},
 		MaxN:    0,
 		MinN:    0,
 		Choices: make([]string, 0),
 	}}
 
 	mainSubject.Ranks = []Rank{{
 		ID:      encodedQuestionID(1),
-		Title:   "",
+		Title:   Title{En: "", Fr: "", De: ""},
 		MaxN:    0,
 		MinN:    0,
 		Choices: make([]string, 0),
@@ -423,7 +423,7 @@ func TestSubject_IsValid(t *testing.T) {
 
 	mainSubject.Ranks[0] = Rank{
 		ID:      encodedQuestionID(2),
-		Title:   "",
+		Title:   Title{En: "", Fr: "", De: ""},
 		MaxN:    0,
 		MinN:    2,
 		Choices: make([]string, 0),
@@ -439,7 +439,7 @@ func TestSubject_IsValid(t *testing.T) {
 	mainSubject.Ranks = []Rank{}
 	mainSubject.Selects[0] = Select{
 		ID:      encodedQuestionID(1),
-		Title:   "",
+		Title:   Title{En: "", Fr: "", De: ""},
 		MaxN:    1,
 		MinN:    0,
 		Choices: make([]string, 0),
@@ -455,7 +455,7 @@ func TestSubject_IsValid(t *testing.T) {
 	mainSubject.Selects = []Select{}
 	mainSubject.Texts = []Text{{
 		ID:        encodedQuestionID(3),
-		Title:     "",
+		Title:     Title{En: "", Fr: "", De: ""},
 		MaxN:      2,
 		MinN:      4,
 		MaxLength: 0,

diff --git a/contracts/evoting/types/election.go b/contracts/evoting/types/election.go
@@ -197,8 +197,8 @@ type ShuffleInstance struct {
 
 // Configuration contains the configuration of a new poll.
 type Configuration struct {
-	MainTitle string
-	Scaffold  []Subject
+	Title    Title
+	Scaffold []Subject
 }
 
 // MaxBallotSize returns the maximum number of bytes required to store a ballot

diff --git a/integration/integration_test.go b/integration/integration_test.go
@@ -141,7 +141,7 @@ func getIntegrationTest(numNodes, numVotes int) func(*testing.T) {
 		form, err = getForm(formFac, formID, nodes[0].GetOrdering())
 		require.NoError(t, err)
 
-		fmt.Println("Title of the form : " + form.Configuration.MainTitle)
+		fmt.Println("Title of the form : " + form.Configuration.Title.En)
 		fmt.Println("ID of the form : " + string(form.FormID))
 		fmt.Println("Status of the form : " + strconv.Itoa(int(form.Status)))
 		fmt.Println("Number of decrypted ballots : " + strconv.Itoa(len(form.DecryptedBallots)))
@@ -304,7 +304,7 @@ func getIntegrationTestCrash(numNodes, numVotes, failingNodes int) func(*testing
 		form, err = getForm(formFac, formID, nodes[0].GetOrdering())
 		require.NoError(t, err)
 
-		fmt.Println("Title of the form : " + form.Configuration.MainTitle)
+		fmt.Println("Title of the form : " + form.Configuration.Title.En)
 		fmt.Println("ID of the form : " + string(form.FormID))
 		fmt.Println("Status of the form : " + strconv.Itoa(int(form.Status)))
 		fmt.Println("Number of decrypted ballots : " + strconv.Itoa(len(form.DecryptedBallots)))
@@ -425,7 +425,7 @@ func getIntegrationBenchmark(numNodes, numVotes int) func(*testing.B) {
 		form, err = getForm(formFac, formID, nodes[0].GetOrdering())
 		require.NoError(b, err)
 
-		fmt.Println("Title of the form : " + form.Configuration.MainTitle)
+		fmt.Println("Title of the form : " + form.Configuration.Title.En)
 		fmt.Println("ID of the form : " + string(form.FormID))
 		fmt.Println("Status of the form : " + strconv.Itoa(int(form.Status)))
 		fmt.Println("Number of decrypted ballots : " + strconv.Itoa(len(form.DecryptedBallots)))

diff --git a/integration/performance_test.go b/integration/performance_test.go
@@ -61,7 +61,7 @@ func BenchmarkIntegration_CustomVotesScenario(b *testing.B) {
 	}
 
 	// ##### CREATE FORM #####
-	formID, err := createFormNChunks(m, "Three votes form", adminID, numChunksPerBallot)
+	formID, err := createFormNChunks(m, types.Title{En: "Three votes form", Fr: "", De: ""}, adminID, numChunksPerBallot)
 	require.NoError(b, err)
 
 	time.Sleep(time.Millisecond * 1000)
@@ -124,7 +124,7 @@ func BenchmarkIntegration_CustomVotesScenario(b *testing.B) {
 	form, err = getForm(formFac, formID, nodes[0].GetOrdering())
 	require.NoError(b, err)
 
-	fmt.Println("Title of the form : " + form.Configuration.MainTitle)
+	fmt.Println("Title of the form : " + form.Configuration.Title.En)
 	fmt.Println("ID of the form : " + string(form.FormID))
 	fmt.Println("Status of the form : " + strconv.Itoa(int(form.Status)))
 	fmt.Println("Number of decrypted ballots : " + strconv.Itoa(len(form.DecryptedBallots)))
@@ -146,25 +146,25 @@ func BenchmarkIntegration_CustomVotesScenario(b *testing.B) {
 	closeNodesBench(b, nodes)
 }
 
-func createFormNChunks(m txManager, title string, admin string, numChunks int) ([]byte, error) {
+func createFormNChunks(m txManager, title types.Title, admin string, numChunks int) ([]byte, error) {
 
 	defaultBallotContent := "text:" + encodeID("bb") + ":\n\n"
 	textSize := 29*numChunks - len(defaultBallotContent)
 
 	// Define the configuration :
 	configuration := types.Configuration{
-		MainTitle: title,
+		Title: title,
 		Scaffold: []types.Subject{
 			{
 				ID:       "aa",
-				Title:    "subject1",
+				Title:    types.Title{En: "subject1", Fr: "", De: ""},
 				Order:    nil,
 				Subjects: nil,
 				Selects:  nil,
 				Ranks:    []types.Rank{},
 				Texts: []types.Text{{
 					ID:        "bb",
-					Title:     "Enter favorite snack",
+					Title:     types.Title{En: "Enter favorite snack", Fr: "", De: ""},
 					MaxN:      1,
 					MinN:      0,
 					MaxLength: uint(base64.StdEncoding.DecodedLen(textSize)),

diff --git a/integration/votes_test.go b/integration/votes_test.go
@@ -141,7 +141,7 @@ func getIntegrationTestBadVote(numNodes, numVotes, numBadVotes int) func(*testin
 		form, err = getForm(formFac, formID, nodes[0].GetOrdering())
 		require.NoError(t, err)
 
-		fmt.Println("Title of the form : " + form.Configuration.MainTitle)
+		fmt.Println("Title of the form : " + form.Configuration.Title.En)
 		fmt.Println("ID of the form : " + string(form.FormID))
 		fmt.Println("Status of the form : " + strconv.Itoa(int(form.Status)))
 		fmt.Println("Number of decrypted ballots : " + strconv.Itoa(len(form.DecryptedBallots)))
@@ -281,7 +281,7 @@ func getIntegrationTestRevote(numNodes, numVotes, numRevotes int) func(*testing.
 		form, err = getForm(formFac, formID, nodes[0].GetOrdering())
 		require.NoError(t, err)
 
-		fmt.Println("Title of the form : " + form.Configuration.MainTitle)
+		fmt.Println("Title of the form : " + form.Configuration.Title.En)
 		fmt.Println("ID of the form : " + string(form.FormID))
 		fmt.Println("Status of the form : " + strconv.Itoa(int(form.Status)))
 		fmt.Println("Number of decrypted ballots : " + strconv.Itoa(len(form.DecryptedBallots)))