pictl: Add proposal status opt to seedproposals.

This commit adds a --proposalstatus option to the `pictl seedproposals`
command. If provided, all proposals submitted by the command will be set
to the specified proposal status. This makes it easier to fine tune your
testing environment, which is desirable when needing to test specific
features or bug fixes.

It also makes two additional changes to the `seedproposals` command:

- Updates the comment and comment like defaults to be more reasonable.

- Switches the hard coded proposal statuses out for the newly added pi
  plugin proposal statuses.

politeiawww/cmd/pictl/cmdseedproposals.go

@@ -11,6 +11,7 @@ import (
 	"strconv"
 	"time"
 
+	pi "github.com/decred/politeia/politeiad/plugins/pi"
 	cmv1 "github.com/decred/politeia/politeiawww/api/comments/v1"
 	rcv1 "github.com/decred/politeia/politeiawww/api/records/v1"
 	"github.com/decred/politeia/util"
@@ -27,10 +28,11 @@ type cmdSeedProposals struct {
 	// Options to adjust the quantity being seeded. Default values are
 	// used when these flags are not provided. Pointers are used when
 	// a value of 0 is allowed.
-	Users        uint32  `long:"users" optional:"true"`
-	Proposals    uint32  `long:"proposals" optional:"true"`
-	Comments     *uint32 `long:"comments" optional:"true"`
-	CommentVotes *uint32 `long:"commentvotes" optional:"true"`
+	Users          uint32  `long:"users" optional:"true"`
+	Proposals      uint32  `long:"proposals" optional:"true"`
+	Comments       *uint32 `long:"comments" optional:"true"`
+	CommentVotes   *uint32 `long:"commentvotes" optional:"true"`
+	ProposalStatus string  `long:"proposalstatus" optional:"true"`
 
 	// IncludeImages is used to include image attachments in the
 	// proposal submissions. Each proposal will contain a random number
@@ -46,11 +48,13 @@ func (c *cmdSeedProposals) Execute(args []string) error {
 	var (
 		userCount               uint32 = 10
 		proposalCount           uint32 = 25
-		commentsPerProposal     uint32 = 150
+		commentsPerProposal     uint32 = 10
 		commentSize             uint32 = 32 // In characters
-		commentVotesPerProposal uint32 = 500
+		commentVotesPerProposal uint32 = 25
 
 		includeImages = c.IncludeImages
+
+		proposalStatus *pi.PropStatusT
 	)
 	if c.Users != 0 {
 		userCount = c.Users
@@ -64,6 +68,13 @@ func (c *cmdSeedProposals) Execute(args []string) error {
 	if c.CommentVotes != nil {
 		commentVotesPerProposal = *c.CommentVotes
 	}
+	if c.ProposalStatus != "" {
+		s := parseProposalStatus(c.ProposalStatus)
+		if s == pi.PropStatusInvalid {
+			return fmt.Errorf("invalid proposal status '%v'", c.ProposalStatus)
+		}
+		proposalStatus = &s
+	}
 
 	// We don't want the output of individual commands printed.
 	cfg.Verbose = false
@@ -124,33 +135,27 @@ func (c *cmdSeedProposals) Execute(args []string) error {
 
 	// Setup proposals
 	var (
-		statusUnreviewed       = "unreviewed"
-		statusUnvettedCensored = "unvetted-censored"
-		statusPublic           = "public"
-		statusVettedCensored   = "vetted-cesored"
-		statusAbandoned        = "abandoned"
-
 		// statuses specifies the statuses that are rotated through when
 		// proposals are being submitted. We can increase the proption of
 		// proposals that are a specific status by increasing the number
 		// of times the status occurs in this array.
-		statuses = []string{
-			statusPublic,
-			statusPublic,
-			statusPublic,
-			statusPublic,
-			statusUnreviewed,
-			statusUnvettedCensored,
-			statusVettedCensored,
-			statusAbandoned,
+		statuses = []pi.PropStatusT{
+			pi.PropStatusUnderReview,
+			pi.PropStatusUnderReview,
+			pi.PropStatusUnderReview,
+			pi.PropStatusUnderReview,
+			pi.PropStatusUnvetted,
+			pi.PropStatusUnvettedCensored,
+			pi.PropStatusCensored,
+			pi.PropStatusAbandoned,
 		}
 
 		// These are used to track the number of proposals that are
 		// created for each status.
-		countUnreviewed       int
+		countUnvetted         int
 		countUnvettedCensored int
-		countPublic           int
-		countVettedCensored   int
+		countUnderReview      int
+		countCensored         int
 		countAbandoned        int
 
 		// public is used to aggregate the tokens of public proposals.
@@ -165,6 +170,11 @@ func (c *cmdSeedProposals) Execute(args []string) error {
 		// Rotate through the statuses
 		s := statuses[i%len(statuses)]
 
+		// Override the default proposal status if one was provided
+		if proposalStatus != nil {
+			s = *proposalStatus
+		}
+
 		log := fmt.Sprintf("Submitting proposal %v/%v: %v",
 			i+1, proposalCount, s)
 		printInPlace(log)
@@ -175,53 +185,54 @@ func (c *cmdSeedProposals) Execute(args []string) error {
 			RandomImages: includeImages,
 		}
 		switch s {
-		case statusUnreviewed:
+		case pi.PropStatusUnvetted:
 			_, err = proposalUnreviewed(u, opts)
 			if err != nil {
 				return err
 			}
-			countUnreviewed++
-		case statusUnvettedCensored:
+			countUnvetted++
+		case pi.PropStatusUnvettedCensored:
 			_, err = proposalUnvettedCensored(u, admin, opts)
 			if err != nil {
 				return err
 			}
 			countUnvettedCensored++
-		case statusPublic:
+		case pi.PropStatusUnderReview:
 			r, err := proposalPublic(u, admin, opts)
 			if err != nil {
 				return err
 			}
-			countPublic++
+			countUnderReview++
 			public = append(public, r.CensorshipRecord.Token)
-		case statusVettedCensored:
+		case pi.PropStatusCensored:
 			_, err = proposalVettedCensored(u, admin, opts)
 			if err != nil {
 				return err
 			}
-			countVettedCensored++
-		case statusAbandoned:
+			countCensored++
+		case pi.PropStatusAbandoned:
 			_, err = proposalAbandoned(u, admin, opts)
 			if err != nil {
 				return err
 			}
 			countAbandoned++
 		default:
-			return fmt.Errorf("invalid status %v", s)
+			return fmt.Errorf("this command does not "+
+				"support the proposal status '%v'", s)
 		}
 	}
 	fmt.Printf("\n")
 
 	// Verify proposal inventory
 	var (
 		statusesUnvetted = map[rcv1.RecordStatusT]int{
-			rcv1.RecordStatusUnreviewed: countUnreviewed,
+			rcv1.RecordStatusUnreviewed: countUnvetted,
 			rcv1.RecordStatusCensored:   countUnvettedCensored,
 		}
 
 		statusesVetted = map[rcv1.RecordStatusT]int{
-			rcv1.RecordStatusPublic:   countPublic,
-			rcv1.RecordStatusCensored: countVettedCensored,
+			rcv1.RecordStatusPublic:   countUnderReview,
+			rcv1.RecordStatusCensored: countCensored,
 			rcv1.RecordStatusArchived: countAbandoned,
 		}
 	)
@@ -541,15 +552,26 @@ Arguments:
 2. adminpassword  (string, required)  Password for admin account.
 
 Flags:
- --users         (uint32) Number of users to seed the backend with.
-                          (default: 10)
- --proposals     (uint32) Number of proposals to seed the backend with.
-                          (default: 25)
- --comments      (uint32) Number of comments that will be made on each
-                          proposal. (default: 150)
- --commentvotes  (uint32) Number of comment upvotes/downvotes that will be cast
-                          on each proposal. (default: 500)
- --includeimages (bool)   Include images in proposal submissions. This will
-                          substantially increase the size of the proposal
-                          payload.
+ --users          (uint32) Number of users to seed the backend with.
+                           (default: 10)
+
+ --proposals      (uint32) Number of proposals to seed the backend with.
+                           (default: 25)
+
+ --comments       (uint32) Number of comments that will be made on each
+                           proposal. (default: 10)
+ 
+ --commentvotes   (uint32) Number of comment upvotes/downvotes that will be
+                           cast on each proposal. (default: 25)
+
+ --proposalstatus (string) Proposal status that all of the seeded proposals
+                           will be set to.
+                           Valid options: unvetted, unvetted-censored,
+                           under-review, censored, or abandoned.
+                           By default, the seeded proposals will cycle through
+                           all of these statuses.
+
+ --includeimages  (bool)   Include images in proposal submissions. This will
+                           substantially increase the size of the proposal
+                           payload.
 `

politeiawww/cmd/pictl/proposal.go

@@ -20,6 +20,7 @@ import (
 
 	"github.com/decred/politeia/politeiad/api/v1/identity"
 	"github.com/decred/politeia/politeiad/api/v1/mime"
+	pi "github.com/decred/politeia/politeiad/plugins/pi"
 	piplugin "github.com/decred/politeia/politeiad/plugins/pi"
 	piv1 "github.com/decred/politeia/politeiawww/api/pi/v1"
 	rcv1 "github.com/decred/politeia/politeiawww/api/records/v1"
@@ -275,3 +276,28 @@ func signedMerkleRoot(files []rcv1.File, fid *identity.FullIdentity) (string, er
 	sig := fid.SignMessage([]byte(mr))
 	return hex.EncodeToString(sig[:]), nil
 }
+
+// parseProposalStatus parses a pi PropStatusT from the provided string. A
+// PropStatusInvalid is returned if the provided string does not correspond to
+// a valid proposal status.
+func parseProposalStatus(status string) pi.PropStatusT {
+	switch pi.PropStatusT(status) {
+	// The following are valid proposal statuses
+	case pi.PropStatusUnvetted,
+		pi.PropStatusUnvettedAbandoned,
+		pi.PropStatusUnvettedCensored,
+		pi.PropStatusUnderReview,
+		pi.PropStatusAbandoned,
+		pi.PropStatusCensored,
+		pi.PropStatusVoteAuthorized,
+		pi.PropStatusVoteStarted,
+		pi.PropStatusApproved,
+		pi.PropStatusRejected,
+		pi.PropStatusActive,
+		pi.PropStatusCompleted,
+		pi.PropStatusClosed:
+	default:
+		return pi.PropStatusInvalid
+	}
+	return pi.PropStatusT(status)
+}