1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api
21 
22 import cats.data.NonEmptyList
23 import eu.timepit.refined.api.Refined
24 import eu.timepit.refined.auto._
25 import eu.timepit.refined.collection._
26 import eu.timepit.refined.refineV
27 import eu.timepit.refined.types.numeric.NonNegInt
28 import org.make.api.proposal.ProposalScorer
29 import org.make.api.proposal.ProposalScorer.VotesCounter
30 import org.make.core.sequence.{
31   ExplorationSequenceConfiguration,
32   ExplorationSequenceConfigurationId,
33   SequenceConfiguration,
34   SpecificSequenceConfiguration,
35   SpecificSequenceConfigurationId
36 }
37 import org.make.core.auth.{Client, ClientId}
38 import org.make.core.demographics.{DemographicsCard, DemographicsCardId}
39 import org.make.core.idea.{Idea, IdeaId, IdeaStatus}
40 import org.make.core.keyword.Keyword
41 import org.make.core.operation._
42 import org.make.core.operation.indexed.IndexedOperationOfQuestion
43 import org.make.core.partner.{Partner, PartnerId, PartnerKind}
44 import org.make.core.post.indexed.IndexedPost
45 import org.make.core.post.{Post, PostId}
46 import org.make.core.profile.Profile
47 import org.make.core.proposal._
48 import org.make.core.technical.Multilingual
49 import org.make.core.proposal.indexed._
50 import org.make.core.proposal.ProposalStatus.Accepted
51 import org.make.core.proposal.QualificationKey._
52 import org.make.core.proposal.VoteKey.{Agree, Disagree, Neutral}
53 import org.make.core.question.{Question, QuestionId}
54 import org.make.core.reference.{Country, Language}
55 import org.make.core.tag.{Tag, TagDisplay, TagId, TagType, TagTypeId}
56 import org.make.core.user.Role.RoleCitizen
57 import org.make.core.user._
58 import org.make.core.widget.{Source, SourceId}
59 import org.make.core.{DateHelper, EventId, RequestContext, SlugHelper}
60 
61 import java.net.URI
62 import java.time.{ZoneId, ZonedDateTime}
63 import org.make.core.demographics.LabelsValue
64 
65 trait TestUtils {
66 
67   private val defaultVotes: VotingOptions = VotingOptions(
68     AgreeWrapper(
69       vote = Vote(
70         key = Agree,
71         count = 0,
72         countVerified = 0,
73         countSegment = 0,
74         countSequence = 0,
75         qualifications = Seq.empty
76       ),
77       likeIt = Qualification(key = LikeIt, count = 0, countVerified = 0, countSequence = 0, countSegment = 0),
78       doable = Qualification(key = Doable, count = 0, countVerified = 0, countSequence = 0, countSegment = 0),
79       platitudeAgree =
80         Qualification(key = PlatitudeAgree, count = 0, countVerified = 0, countSequence = 0, countSegment = 0)
81     ),
82     NeutralWrapper(
83       vote = Vote(
84         key = Neutral,
85         count = 0,
86         countVerified = 0,
87         countSegment = 0,
88         countSequence = 0,
89         qualifications = Seq.empty
90       ),
91       doNotUnderstand =
92         Qualification(key = DoNotUnderstand, count = 0, countVerified = 0, countSequence = 0, countSegment = 0),
93       noOpinion = Qualification(key = NoOpinion, count = 0, countVerified = 0, countSequence = 0, countSegment = 0),
94       doNotCare = Qualification(key = DoNotCare, count = 0, countVerified = 0, countSequence = 0, countSegment = 0)
95     ),
96     DisagreeWrapper(
97       vote = Vote(
98         key = Disagree,
99         count = 0,
100         countVerified = 0,
101         countSegment = 0,
102         countSequence = 0,
103         qualifications = Seq.empty
104       ),
105       noWay = Qualification(key = NoWay, count = 0, countVerified = 0, countSequence = 0, countSegment = 0),
106       impossible = Qualification(key = Impossible, count = 0, countVerified = 0, countSequence = 0, countSegment = 0),
107       platitudeDisagree =
108         Qualification(key = PlatitudeDisagree, count = 0, countVerified = 0, countSequence = 0, countSegment = 0)
109     )
110   )
111 
112   def proposal(
113     id: ProposalId,
114     votes: VotingOptions = defaultVotes,
115     author: UserId = UserId("author"),
116     tags: Seq[TagId] = Seq.empty,
117     organisations: Seq[OrganisationInfo] = Seq.empty,
118     questionId: QuestionId = QuestionId("question"),
119     operationId: Option[OperationId] = Some(OperationId("operation")),
120     requestContext: RequestContext = RequestContext.empty,
121     content: String = "Il faut tester l'indexation des propositions",
122     status: ProposalStatus = Accepted,
123     refusalReason: Option[String] = None,
124     idea: Option[IdeaId] = None,
125     events: List[ProposalAction] = Nil,
126     proposalType: ProposalType = ProposalType.ProposalTypeSubmitted,
127     createdAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T10:10:10.000Z")),
128     updatedAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T15:10:10.000Z")),
129     validatedAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T15:10:10.000Z")),
130     postponedAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T15:10:10.000Z")),
131     keywords: Seq[ProposalKeyword] = Nil
132   ): Proposal = {
133     Proposal(
134       proposalId = id,
135       votingOptions = Some(votes),
136       content = content,
137       submittedAsLanguage = Some(Language("fr")),
138       contentTranslations = None,
139       slug = SlugHelper(content),
140       author = author,
141       status = status,
142       refusalReason = refusalReason,
143       tags = tags,
144       organisationIds = organisations.map(_.organisationId),
145       questionId = Some(questionId),
146       creationContext = requestContext,
147       idea = idea,
148       operation = operationId,
149       proposalType = proposalType,
150       createdAt = createdAt,
151       updatedAt = updatedAt,
152       validatedAt = validatedAt.filter(_ => status == ProposalStatus.Accepted || status == ProposalStatus.Refused),
153       postponedAt = postponedAt.filter(_ => status == ProposalStatus.Postponed),
154       events = events,
155       keywords = keywords
156     )
157   }
158 
159   private val defaultAuthor: IndexedAuthor = IndexedAuthor(
160     userId = UserId("12345"),
161     firstName = Some("firstname"),
162     displayName = Some("firstname"),
163     organisationName = None,
164     organisationSlug = None,
165     postalCode = Some("12345"),
166     age = Some(25),
167     avatarUrl = Some("http://some-url"),
168     userType = UserType.UserTypeUser,
169     profession = Some("Tarot Reader")
170   )
171 
172   def indexedProposal(
173     id: ProposalId,
174     votingOptions: VotingOptions = VotingOptions.empty,
175     userId: UserId = UserId("author"),
176     author: IndexedAuthor = defaultAuthor,
177     questionId: QuestionId = QuestionId("question-id"),
178     operationId: Option[OperationId] = Some(OperationId("operation-id")),
179     startDate: ZonedDateTime = ZonedDateTime.parse("1968-07-03T00:00:00.000Z"),
180     endDate: ZonedDateTime = ZonedDateTime.parse("2068-07-03T00:00:00.000Z"),
181     requestContext: Option[RequestContext] = None,
182     content: String = "Il faut tester l'indexation des propositions",
183     countries: NonEmptyList[Country] = NonEmptyList.of(Country("FR")),
184     defaultLanguage: Language = Language("fr"),
185     languages: NonEmptyList[Language] = NonEmptyList.of(Language("fr")),
186     status: ProposalStatus = Accepted,
187     refusalReason: Option[String] = None,
188     ideaId: Option[IdeaId] = None,
189     selectedStakeTag: Option[IndexedTag] = None,
190     initialProposal: Boolean = false,
191     proposalType: ProposalType = ProposalType.ProposalTypeSubmitted,
192     createdAt: ZonedDateTime = ZonedDateTime.parse("2019-10-10T10:10:10.000Z"),
193     updatedAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T15:10:10.000Z")),
194     validatedAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T15:10:10.000Z")),
195     postponedAt: Option[ZonedDateTime] = Some(ZonedDateTime.parse("2019-10-10T15:10:10.000Z")),
196     toEnrich: Boolean = false,
197     keywords: Seq[IndexedProposalKeyword] = Nil,
198     tags: Seq[IndexedTag] = Nil,
199     sequencePool: SequencePool = SequencePool.New,
200     sequenceSegmentPool: SequencePool = SequencePool.New,
201     segment: Option[String] = None
202   ): IndexedProposal = {
203     val regularScore = ProposalScorer(votingOptions, VotesCounter.SequenceVotesCounter, 0.5)
204     val segmentScore = ProposalScorer(votingOptions, VotesCounter.SegmentVotesCounter, 0.5)
205     val authorWithId = author.copy(userId = userId)
206     val seqThreshold = ExplorationSequenceConfiguration.SequenceThresholds.default
207 
208     IndexedProposal(
209       id = id,
210       submittedAsLanguage = Some(defaultLanguage),
211       content = Multilingual((defaultLanguage, content)),
212       contentGeneral = content,
213       contentKeyword = content,
214       slug = SlugHelper(content),
215       status = status,
216       createdAt = createdAt,
217       updatedAt = updatedAt,
218       validatedAt = validatedAt,
219       postponedAt = postponedAt,
220       votes = votingOptions,
221       votesCount = votingOptions.counts.totalVotes,
222       votesVerifiedCount = votingOptions.verifiedCounts.totalVotes,
223       votesSequenceCount = votingOptions.sequenceCounts.totalVotes,
224       votesSegmentCount = votingOptions.segmentCounts.totalVotes,
225       toEnrich = toEnrich,
226       scores = IndexedScores(regularScore, seqThreshold),
227       segmentScores = IndexedScores(segmentScore, seqThreshold),
228       agreementRate = BaseVote.rate(votingOptions, VoteKey.Agree),
229       context = requestContext.map(IndexedContext.apply(_)),
230       isAnonymous = false,
231       author = authorWithId,
232       organisations = Seq.empty,
233       tags = tags,
234       selectedStakeTag = selectedStakeTag,
235       ideaId = ideaId,
236       operationId = operationId,
237       question = Some(
238         IndexedProposalQuestion(
239           questionId = questionId,
240           slug = questionId.value,
241           titles = Multilingual((defaultLanguage, questionId.value)),
242           questions = Multilingual((defaultLanguage, refineV[NonEmpty].unsafeFrom(questionId.value))),
243           countries = countries,
244           languages = languages,
245           startDate = startDate,
246           endDate = endDate,
247           isOpen = true
248         )
249       ),
250       sequencePool = sequencePool,
251       sequenceSegmentPool = sequenceSegmentPool,
252       initialProposal = initialProposal,
253       proposalType = proposalType,
254       refusalReason = refusalReason,
255       operationKind = None,
256       segment = segment,
257       keywords = keywords
258     )
259   }
260 
261   def user(
262     id: UserId,
263     email: String = "test@make.org",
264     firstName: Option[String] = Some("Joe"),
265     lastName: Option[String] = Some("Chip"),
266     lastIp: Option[String] = None,
267     hashedPassword: Option[String] = None,
268     enabled: Boolean = true,
269     emailVerified: Boolean = true,
270     lastConnection: Option[ZonedDateTime] = Some(ZonedDateTime.parse("1992-08-23T02:02:02.020Z")),
271     verificationToken: Option[String] = None,
272     verificationTokenExpiresAt: Option[ZonedDateTime] = None,
273     resetToken: Option[String] = None,
274     resetTokenExpiresAt: Option[ZonedDateTime] = None,
275     roles: Seq[Role] = Seq(RoleCitizen),
276     country: Country = Country("FR"),
277     language: Language = Language("fr"),
278     profile: Option[Profile] = None,
279     createdAt: Option[ZonedDateTime] = Some(DateHelper.now()),
280     updatedAt: Option[ZonedDateTime] = None,
281     isHardBounce: Boolean = false,
282     lastMailingError: Option[MailingErrorLog] = None,
283     organisationName: Option[String] = None,
284     availableQuestions: Seq[QuestionId] = Seq.empty,
285     availableEvents: Seq[EventId] = Seq.empty,
286     userType: UserType = UserType.UserTypeUser,
287     privacyPolicyApprovalDate: Option[ZonedDateTime] = None,
288     lastFailedConnectionAttempt: Option[ZonedDateTime] = None,
289     connectionAttemptsSinceLastSuccessful: Int = 1
290   ): User = {
291     User(
292       userId = id,
293       email = email,
294       firstName = firstName,
295       lastName = lastName,
296       lastIp = lastIp,
297       hashedPassword = hashedPassword,
298       enabled = enabled,
299       emailVerified = emailVerified,
300       lastConnection = lastConnection,
301       verificationToken = verificationToken,
302       verificationTokenExpiresAt = verificationTokenExpiresAt,
303       resetToken = resetToken,
304       resetTokenExpiresAt = resetTokenExpiresAt,
305       roles = roles,
306       country = country,
307       language = language,
308       profile = profile,
309       createdAt = createdAt,
310       updatedAt = updatedAt,
311       isHardBounce = isHardBounce,
312       lastMailingError = lastMailingError,
313       organisationName = organisationName,
314       availableQuestions = availableQuestions,
315       availableEvents = availableEvents,
316       userType = userType,
317       privacyPolicyApprovalDate = privacyPolicyApprovalDate,
318       lastFailedConnectionAttempt = lastFailedConnectionAttempt,
319       connectionAttemptsSinceLastSuccessful = connectionAttemptsSinceLastSuccessful
320     )
321   }
322 
323   def question(
324     id: QuestionId,
325     slug: String = "question-slug",
326     countries: NonEmptyList[Country] = NonEmptyList.of(Country("FR")),
327     defaultLanguage: Language = Language("fr"),
328     languages: NonEmptyList[Language] = NonEmptyList.of(Language("fr")),
329     questions: Multilingual[String Refined NonEmpty] = Multilingual(
330       Language("fr") -> ("How to ask a question ?": String Refined NonEmpty)
331     ),
332     shortTitles: Option[Multilingual[String Refined NonEmpty]] = None,
333     operationId: Option[OperationId] = None
334   ): Question =
335     Question(
336       questionId = id,
337       slug = slug,
338       countries = countries,
339       defaultLanguage = defaultLanguage,
340       languages = languages,
341       questions = questions,
342       shortTitles = shortTitles,
343       operationId = operationId
344     )
345 
346   def simpleOperation(
347     id: OperationId,
348     slug: String = "operation-slug",
349     operationKind: OperationKind = OperationKind.BusinessConsultation,
350     operationAuthentication: Option[OperationAuthentication] = None,
351     createdAt: Option[ZonedDateTime] = None,
352     updatedAt: Option[ZonedDateTime] = None
353   ): SimpleOperation =
354     SimpleOperation(
355       operationId = id,
356       slug = slug,
357       operationKind = operationKind,
358       operationAuthentication = operationAuthentication,
359       createdAt = createdAt,
360       updatedAt = updatedAt
361     )
362 
363   def operation(
364     operationId: OperationId,
365     slug: String = "operation-slug",
366     events: List[OperationAction] = List.empty,
367     questions: Seq[QuestionWithDetails] = Seq.empty,
368     operationKind: OperationKind = OperationKind.BusinessConsultation,
369     operationAuthentication: Option[OperationAuthentication] = None,
370     createdAt: Option[ZonedDateTime] = None,
371     updatedAt: Option[ZonedDateTime] = None
372   ): Operation = Operation(
373     operationId = operationId,
374     slug = slug,
375     operationKind = operationKind,
376     operationAuthentication = operationAuthentication,
377     createdAt = createdAt,
378     updatedAt = updatedAt,
379     events = events,
380     questions = questions
381   )
382 
383   val defaultMetas: Metas =
384     Metas(
385       titles = Some(Multilingual.fromDefault("Metas title")),
386       descriptions = Some(Multilingual.fromDefault("Meta description")),
387       picture = None
388     )
389   def operationOfQuestion(
390     questionId: QuestionId,
391     operationId: OperationId,
392     startDate: ZonedDateTime = ZonedDateTime.parse("1968-07-03T00:00:00.000Z"),
393     endDate: ZonedDateTime = ZonedDateTime.parse("2068-07-03T00:00:00.000Z"),
394     operationTitles: Multilingual[String] = Multilingual.fromDefault("operation title"),
395     proposalPrefixes: Multilingual[String] = Multilingual.fromDefault("Il faut"),
396     canPropose: Boolean = true,
397     sequenceCardsConfiguration: SequenceCardsConfiguration = SequenceCardsConfiguration.default,
398     aboutUrls: Option[Multilingual[String]] = None,
399     metas: Metas = defaultMetas,
400     theme: QuestionTheme = QuestionTheme.default,
401     descriptions: Option[Multilingual[String]] = None,
402     consultationImages: Option[Multilingual[String]] = Some(Multilingual.fromDefault("image-url")),
403     consultationImageAlts: Option[Multilingual[String Refined MaxSize[130]]] = Some(
404       Multilingual.fromDefault("image alternative")
405     ),
406     descriptionImages: Option[Multilingual[String]] = None,
407     descriptionImageAlts: Option[Multilingual[String Refined MaxSize[130]]] = None,
408     partnersLogos: Option[String] = None,
409     partnersLogosAlt: Option[String Refined MaxSize[130]] = None,
410     initiatorsLogos: Option[String] = None,
411     initiatorsLogosAlt: Option[String Refined MaxSize[130]] = None,
412     consultationHeader: Option[String] = None,
413     consultationHeaderAlts: Option[Multilingual[String Refined MaxSize[130]]] = None,
414     cobrandingLogo: Option[String] = None,
415     cobrandingLogoAlt: Option[String Refined MaxSize[130]] = None,
416     resultsLink: Option[ResultsLink] = None,
417     proposalsCount: Int = 42,
418     participantsCount: Int = 84,
419     actions: Option[String] = None,
420     featured: Boolean = false,
421     votesCount: Int = 0,
422     votesTarget: Int = 100_000,
423     timeline: OperationOfQuestionTimeline = OperationOfQuestionTimeline(None, None, None),
424     createdAt: ZonedDateTime = ZonedDateTime.parse("1968-06-03T00:00:00.000Z"),
425     sessionBindingMode: Boolean = false,
426     reportUrl: Option[String] = None,
427     actionsUrl: Option[String] = None
428   ): OperationOfQuestion = OperationOfQuestion(
429     questionId = questionId,
430     operationId = operationId,
431     startDate = startDate,
432     endDate = endDate,
433     operationTitles = operationTitles,
434     proposalPrefixes = proposalPrefixes,
435     canPropose = canPropose,
436     sequenceCardsConfiguration = sequenceCardsConfiguration,
437     aboutUrls = aboutUrls,
438     metas = metas,
439     theme = theme,
440     descriptions = descriptions,
441     consultationImages = consultationImages,
442     consultationImageAlts = consultationImageAlts,
443     descriptionImages = descriptionImages,
444     descriptionImageAlts = descriptionImageAlts,
445     partnersLogos = partnersLogos,
446     partnersLogosAlt = partnersLogosAlt,
447     initiatorsLogos = initiatorsLogos,
448     initiatorsLogosAlt = initiatorsLogosAlt,
449     consultationHeader = consultationHeader,
450     consultationHeaderAlts = consultationHeaderAlts,
451     cobrandingLogo = cobrandingLogo,
452     cobrandingLogoAlt = cobrandingLogoAlt,
453     resultsLink = resultsLink,
454     proposalsCount = proposalsCount,
455     participantsCount = participantsCount,
456     actions = actions,
457     featured = featured,
458     votesCount = votesCount,
459     votesTarget = votesTarget,
460     timeline = timeline,
461     createdAt = createdAt,
462     sessionBindingMode = sessionBindingMode,
463     reportUrl = reportUrl,
464     actionsUrl = actionsUrl
465   )
466 
467   def indexedOperationOfQuestion(
468     questionId: QuestionId,
469     operationId: OperationId,
470     questions: Multilingual[String Refined NonEmpty] =
471       Multilingual.fromDefault("What's the question?": String Refined NonEmpty),
472     questionGeneral: String Refined NonEmpty = "What's the question?": String Refined NonEmpty,
473     questionKeyword: String Refined NonEmpty = "What's the question?": String Refined NonEmpty,
474     slug: String = "question-slug",
475     questionShortTitles: Option[Multilingual[String Refined NonEmpty]] = Some(
476       Multilingual.fromDefault("short title": String Refined NonEmpty)
477     ),
478     startDate: ZonedDateTime = ZonedDateTime.parse("1968-07-03T00:00:00.000Z"),
479     endDate: ZonedDateTime = ZonedDateTime.parse("2068-07-03T00:00:00.000Z"),
480     status: OperationOfQuestion.Status = OperationOfQuestion.Status.Open,
481     theme: QuestionTheme = QuestionTheme.default,
482     descriptions: Option[Multilingual[String]] = None,
483     consultationImages: Option[Multilingual[String]] = Some(Multilingual.fromDefault("image-url")),
484     consultationImageAlts: Option[Multilingual[String Refined MaxSize[130]]] = Some(
485       Multilingual.fromDefault("image alternative")
486     ),
487     descriptionImages: Option[Multilingual[String]] = None,
488     descriptionImageAlts: Option[Multilingual[String Refined MaxSize[130]]] = None,
489     countries: NonEmptyList[Country] = NonEmptyList.of(Country("FR")),
490     defaultLanguage: Language = Language("fr"),
491     languages: NonEmptyList[Language] = NonEmptyList.of(Language("fr")),
492     operationTitles: Multilingual[String] = Multilingual.fromDefault("operation title"),
493     operationKind: String = OperationKind.GreatCause.value,
494     aboutUrls: Option[Multilingual[String]] = None,
495     resultsLink: Option[String] = None,
496     proposalsCount: Int = 42,
497     participantsCount: Int = 84,
498     votesCount: Int = 2048,
499     actions: Option[String] = None,
500     featured: Boolean = true,
501     top20ConsensusThreshold: Option[Double] = None
502   ): IndexedOperationOfQuestion = IndexedOperationOfQuestion(
503     questionId = questionId,
504     questions = questions,
505     questionGeneral = questionGeneral,
506     questionKeyword = questionKeyword,
507     slug = slug,
508     questionShortTitles = questionShortTitles,
509     startDate = startDate,
510     endDate = endDate,
511     status = status,
512     theme = theme,
513     descriptions = descriptions,
514     consultationImages = consultationImages,
515     consultationImageAlts = consultationImageAlts,
516     descriptionImages = descriptionImages,
517     descriptionImageAlts = descriptionImageAlts,
518     countries = countries,
519     languages = languages,
520     defaultLanguage = defaultLanguage,
521     operationId = operationId,
522     operationTitles = operationTitles,
523     operationKind = operationKind,
524     aboutUrls = aboutUrls,
525     resultsLink = resultsLink,
526     proposalsCount = proposalsCount,
527     participantsCount = participantsCount,
528     votesCount = votesCount,
529     actions = actions,
530     featured = featured,
531     top20ConsensusThreshold = top20ConsensusThreshold
532   )
533 
534   def postGen(
535     postId: PostId,
536     name: String = "post name",
537     slug: String = "post-slug",
538     displayHome: Boolean = true,
539     postDate: ZonedDateTime = ZonedDateTime.parse("2020-06-10T10:10:10.000Z"),
540     thumbnailUrl: URI = new URI("https://example.com/thumbnail"),
541     thumbnailAlt: Option[String] = Some("image alternative"),
542     sourceUrl: URI = new URI("https://example.com/source"),
543     summary: String = "This is a summary for an awesome post.",
544     country: Country = Country("FR")
545   ): Post = Post(
546     postId = postId,
547     name = name,
548     slug = slug,
549     displayHome = displayHome,
550     postDate = postDate,
551     thumbnailUrl = thumbnailUrl,
552     thumbnailAlt = thumbnailAlt,
553     sourceUrl = sourceUrl,
554     summary = summary,
555     country = country
556   )
557 
558   def indexedPost(
559     postId: PostId,
560     name: String = "post name",
561     slug: String = "post-slug",
562     displayHome: Boolean = true,
563     postDate: ZonedDateTime = ZonedDateTime.parse("2020-06-10T10:10:10.000Z"),
564     thumbnailUrl: URI = new URI("https://example.com/thumbnail"),
565     thumbnailAlt: Option[String] = Some("image alternative"),
566     sourceUrl: URI = new URI("https://example.com/source"),
567     summary: String = "This is a summary for an awesome post.",
568     country: Country = Country("FR")
569   ): IndexedPost =
570     IndexedPost(
571       postId = postId,
572       name = name,
573       slug = slug,
574       displayHome = displayHome,
575       postDate = postDate,
576       thumbnailUrl = thumbnailUrl,
577       thumbnailAlt = thumbnailAlt,
578       sourceUrl = sourceUrl,
579       summary = summary,
580       country = country
581     )
582 
583   def client(
584     clientId: ClientId,
585     name: String = "default",
586     allowedGrantTypes: Seq[String] = Seq.empty,
587     secret: Option[String] = None,
588     scope: Option[String] = None,
589     redirectUri: Option[String] = None,
590     defaultUserId: Option[UserId] = None,
591     roles: Seq[Role] = Seq.empty,
592     tokenExpirationSeconds: Int = 300,
593     refreshExpirationSeconds: Int = 400,
594     reconnectExpirationSeconds: Int = 900
595   ): Client = {
596     Client(
597       clientId = clientId,
598       name = name,
599       allowedGrantTypes = allowedGrantTypes,
600       secret = secret,
601       scope = scope,
602       redirectUri = redirectUri,
603       defaultUserId = defaultUserId,
604       roles = roles,
605       tokenExpirationSeconds = tokenExpirationSeconds,
606       refreshExpirationSeconds = refreshExpirationSeconds,
607       reconnectExpirationSeconds = reconnectExpirationSeconds
608     )
609   }
610 
611   def idea(
612     ideaId: IdeaId,
613     name: String = "idea name",
614     operationId: Option[OperationId] = None,
615     questionId: Option[QuestionId] = None,
616     status: IdeaStatus = IdeaStatus.Activated,
617     createdAt: Option[ZonedDateTime] = None,
618     updatedAt: Option[ZonedDateTime] = None
619   ): Idea =
620     Idea(
621       ideaId = ideaId,
622       name = name,
623       operationId = operationId,
624       questionId = questionId,
625       status = status,
626       createdAt = createdAt,
627       updatedAt = updatedAt
628     )
629 
630   def tag(
631     tagId: TagId,
632     label: String = "tag label",
633     display: TagDisplay = TagDisplay.Inherit,
634     tagTypeId: TagTypeId = TagType.LEGACY.tagTypeId,
635     weight: Float = 42f,
636     operationId: Option[OperationId] = None,
637     questionId: Option[QuestionId] = None
638   ): Tag = Tag(
639     tagId = tagId,
640     label = label,
641     display = display,
642     tagTypeId = tagTypeId,
643     weight = weight,
644     operationId = operationId,
645     questionId = questionId
646   )
647 
648   def sequenceConfiguration(
649     questionId: QuestionId,
650     mainSequence: ExplorationSequenceConfiguration =
651       ExplorationSequenceConfiguration.default(ExplorationSequenceConfigurationId("main-id")),
652     controversial: SpecificSequenceConfiguration = SpecificSequenceConfiguration(
653       SpecificSequenceConfigurationId("controversial-id")
654     ),
655     popular: SpecificSequenceConfiguration = SpecificSequenceConfiguration(
656       SpecificSequenceConfigurationId("popular-id")
657     ),
658     keyword: SpecificSequenceConfiguration = SpecificSequenceConfiguration(
659       SpecificSequenceConfigurationId("keyword-id")
660     ),
661     newProposalsVoteThreshold: Int = 10,
662     testedProposalsEngagementThreshold: Option[Double] = None,
663     testedProposalsScoreThreshold: Option[Double] = None,
664     testedProposalsControversyThreshold: Option[Double] = None,
665     testedProposalsMaxVotesThreshold: Option[Int] = None,
666     nonSequenceVotesWeight: Double = 0.5
667   ): SequenceConfiguration =
668     SequenceConfiguration(
669       questionId = questionId,
670       mainSequence = mainSequence,
671       controversial = controversial,
672       popular = popular,
673       keyword = keyword,
674       newProposalsVoteThreshold = newProposalsVoteThreshold,
675       testedProposalsEngagementThreshold = testedProposalsEngagementThreshold,
676       testedProposalsScoreThreshold = testedProposalsScoreThreshold,
677       testedProposalsControversyThreshold = testedProposalsControversyThreshold,
678       testedProposalsMaxVotesThreshold = testedProposalsMaxVotesThreshold,
679       nonSequenceVotesWeight = nonSequenceVotesWeight
680     )
681 
682   def keyword(
683     questionId: QuestionId,
684     key: String,
685     label: String = "label",
686     score: Float = 0.42f,
687     count: NonNegInt = 21,
688     topKeyword: Boolean = false
689   ): Keyword =
690     Keyword(questionId = questionId, key = key, label = label, score = score, count = count, topKeyword = topKeyword)
691 
692   def source(
693     id: SourceId,
694     userId: UserId,
695     name: String = "name",
696     source: String = "source",
697     createdAt: ZonedDateTime = DateHelper.now(),
698     updatedAt: ZonedDateTime = DateHelper.now()
699   ): Source = Source(id, name, source, createdAt, updatedAt, userId)
700 
701   def demographicsCard(
702     id: DemographicsCardId,
703     questionId: QuestionId,
704     name: String = "Demo name",
705     layout: DemographicsCard.Layout = DemographicsCard.Layout.ThreeColumnsRadio,
706     dataType: String = "data-type",
707     languages: NonEmptyList[Language] = NonEmptyList.of(Language("fr"), Language("de")),
708     titles: Multilingual[String] = Multilingual((Language("fr") -> "Titre démo"), (Language("de") -> "Demo titel")),
709     parameters: NonEmptyList[LabelsValue] = NonEmptyList.of(
710       LabelsValue(label = Multilingual((Language("fr") -> "valeur"), (Language("de") -> "Wert")), value = "value")
711     ),
712     createdAt: ZonedDateTime = DateHelper.now().withZoneSameInstant(ZoneId.systemDefault()),
713     updatedAt: ZonedDateTime = DateHelper.now().withZoneSameInstant(ZoneId.systemDefault())
714   ): DemographicsCard =
715     DemographicsCard(
716       id = id,
717       name = name,
718       layout = layout,
719       dataType = dataType,
720       languages = languages,
721       titles = titles,
722       parameters = parameters,
723       createdAt = createdAt,
724       updatedAt = updatedAt,
725       questionId = questionId
726     )
727 
728   def partner(
729     partnerId: PartnerId,
730     questionId: QuestionId,
731     name: String = "partner-name",
732     logo: Option[String] = None,
733     link: Option[String] = None,
734     organisationId: Option[UserId] = None,
735     partnerKind: PartnerKind = PartnerKind.Founder,
736     weight: Float = 0f
737   ): Partner = Partner(
738     partnerId = partnerId,
739     name = name,
740     logo = logo,
741     link = link,
742     organisationId = organisationId,
743     partnerKind = partnerKind,
744     questionId = questionId,
745     weight = weight
746   )
747 }
748 
749 object TestUtils extends TestUtils