diff --git a/.github/workflows/go-lint.yml b/.github/workflows/go-lint.yml
new file mode 100644
index 0000000..1187b31
--- /dev/null
+++ b/.github/workflows/go-lint.yml
@@ -0,0 +1,31 @@
+name: Golang Linting
+
+on:
+ push:
+ branches: [master, dev]
+ pull_request:
+ branches: [master, dev]
+
+jobs:
+ golang-checks:
+ runs-on: ubuntu-latest
+
+ strategy:
+ matrix:
+ go-version: [1.24]
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Setup Go ${{ matrix.go-version }}
+ uses: actions/setup-go@v5
+ with:
+ go-version: ${{ matrix.go-version }}
+ - name: Install dependencies
+ run: |
+ go mod download
+ - name: Tidy dependencies
+ run: |
+ go mod tidy -diff
+ - name: Check Format
+ run: |
+ gofmt -s -l database logging sse *.go
diff --git a/Dockerfile b/Dockerfile
index 19ec15d..4cf406a 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -2,11 +2,12 @@ FROM docker.io/golang:1.24-alpine AS build
WORKDIR /src/
RUN apk add git
-COPY go* .
-COPY *.go .
+COPY go.* .
+RUN go mod download # do this before build for caching
COPY database database
COPY logging logging
COPY sse sse
+COPY *.go .
RUN go build -v -o vote
FROM docker.io/alpine
diff --git a/README.md b/README.md
index 5d8fc2e..a8deb9f 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@ Implementation
## Configuration
-You'll need to set up these values in your environment. Ask an RTP for OIDC credentials. A docker-compose file is provided for convenience. Otherwise, I trust you to figure it out!
+If you're using the compose file, you'll need to ask an RTP for the vote-dev OIDC secret, and set it as `VOTE_OIDC_SECRET` in your environment
+
+If you're not using the compose file, you'll need more of these
```
VOTE_HOST=http://localhost:8080
@@ -27,10 +29,25 @@ VOTE_SLACK_APP_TOKEN=
VOTE_SLACK_BOT_TOKEN=
```
+### Dev Overrides
+`DEV_DISABLE_ACTIVE_FILTERS="true"` will disable the requirements that you be active to vote
+`DEV_FORCE_IS_EVALS="true"` will force vote to treat all users as the Evals director
+
+## Linting
+These will be checked by CI
+
+```
+# tidy dependencies
+go mod tidy
+
+# format all code according to go standards
+gofmt -w -s *.go logging sse database
+```
+
## To-Dos
- [ ] Don't let the user fuck it up
- [ ] Show E-Board polls with a higher priority
-- [ ] Move Hide Vote to create instead of after you vote :skull:
+- [x] Move Hide Vote to create instead of after you vote :skull:
- [ ] Display the reason why a user is on the results page of a running poll
- [ ] Display minimum time left that a poll is open
diff --git a/database/poll.go b/database/poll.go
index bc1ab84..fcae1db 100644
--- a/database/poll.go
+++ b/database/poll.go
@@ -21,8 +21,11 @@ type Poll struct {
Gatekeep bool `bson:"gatekeep"`
QuorumType float64 `bson:"quorumType"`
AllowedUsers []string `bson:"allowedUsers"`
- Hidden bool `bson:"hidden"`
AllowWriteIns bool `bson:"writeins"`
+
+ // Prevent this poll from having progress displayed
+ // This is important for events like elections where the results shouldn't be visible mid vote
+ Hidden bool `bson:"hidden"`
}
const POLL_TYPE_SIMPLE = "simple"
@@ -69,20 +72,6 @@ func (poll *Poll) Hide(ctx context.Context) error {
return nil
}
-func (poll *Poll) Reveal(ctx context.Context) error {
- ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
- defer cancel()
-
- objId, _ := primitive.ObjectIDFromHex(poll.Id)
-
- _, err := Client.Database(db).Collection("polls").UpdateOne(ctx, map[string]interface{}{"_id": objId}, map[string]interface{}{"$set": map[string]interface{}{"hidden": false}})
- if err != nil {
- return err
- }
-
- return nil
-}
-
func CreatePoll(ctx context.Context, poll *Poll) (string, error) {
ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
defer cancel()
diff --git a/database/ranked_vote.go b/database/ranked_vote.go
index 1ca69e0..b9761e7 100644
--- a/database/ranked_vote.go
+++ b/database/ranked_vote.go
@@ -13,7 +13,6 @@ type RankedVote struct {
Options map[string]int `bson:"options"`
}
-
func CastRankedVote(ctx context.Context, vote *RankedVote, voter *Voter) error {
ctx, cancel := context.WithTimeout(ctx, 10*time.Second)
defer cancel()
diff --git a/docker-compose.yaml b/docker-compose.yaml
index a64adf3..22f5f75 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -12,6 +12,8 @@ services:
VOTE_OIDC_ID: vote-dev
VOTE_OIDC_SECRET: "${VOTE_OIDC_SECRET}"
VOTE_STATE: 27a28540e47ec786b7bdad03f83171b3
+ DEV_DISABLE_ACTIVE_FILTERS: "${DEV_DISABLE_ACTIVE_FILTERS}"
+ DEV_FORCE_IS_EVALS: "${DEV_FORCE_IS_EVALS}"
ports:
- "127.0.0.1:8080:8080"
diff --git a/go.mod b/go.mod
index b7787fe..cb655bd 100644
--- a/go.mod
+++ b/go.mod
@@ -6,6 +6,7 @@ require (
github.com/computersciencehouse/csh-auth v0.1.0
github.com/gin-gonic/gin v1.11.0
github.com/sirupsen/logrus v1.9.3
+ github.com/slack-go/slack v0.17.3
go.mongodb.org/mongo-driver v1.17.6
mvdan.cc/xurls/v2 v2.6.0
)
@@ -38,7 +39,6 @@ require (
github.com/pquerna/cachecontrol v0.2.0 // indirect
github.com/quic-go/qpack v0.5.1 // indirect
github.com/quic-go/quic-go v0.55.0 // indirect
- github.com/slack-go/slack v0.17.3 // indirect
github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
github.com/ugorji/go/codec v1.3.1 // indirect
github.com/xdg-go/pbkdf2 v1.0.0 // indirect
diff --git a/go.sum b/go.sum
index 8a1d4c0..ae41f3b 100644
--- a/go.sum
+++ b/go.sum
@@ -27,6 +27,8 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn
github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
github.com/go-playground/validator/v10 v10.28.0 h1:Q7ibns33JjyW48gHkuFT91qX48KG0ktULL6FgHdG688=
github.com/go-playground/validator/v10 v10.28.0/go.mod h1:GoI6I1SjPBh9p7ykNE/yj3fFYbyDOpwMn5KXd+m2hUU=
+github.com/go-test/deep v1.1.1 h1:0r/53hagsehfO4bzD2Pgr/+RgHqhmf+k1Bpse2cTu1U=
+github.com/go-test/deep v1.1.1/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE=
github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4=
github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
@@ -97,8 +99,6 @@ github.com/xdg-go/stringprep v1.0.4/go.mod h1:mPGuuIYwz7CmR2bT9j4GbQqutWS1zV24gi
github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 h1:ilQV1hzziu+LLM3zUTJ0trRztfwgjqKnBWNtSRkbmwM=
github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78/go.mod h1:aL8wCCfTfSfmXjznFBSZNN13rSJjlIOI1fUNAtF7rmI=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
-go.mongodb.org/mongo-driver v1.17.3 h1:TQyXhnsWfWtgAhMtOgtYHMTkZIfBTpMTsMnd9ZBeHxQ=
-go.mongodb.org/mongo-driver v1.17.3/go.mod h1:Hy04i7O2kC4RS06ZrhPRqj/u4DTYkFDAAccj+rVKqgQ=
go.mongodb.org/mongo-driver v1.17.6 h1:87JUG1wZfWsr6rIz3ZmpH90rL5tea7O3IHuSwHUpsss=
go.mongodb.org/mongo-driver v1.17.6/go.mod h1:Hy04i7O2kC4RS06ZrhPRqj/u4DTYkFDAAccj+rVKqgQ=
go.uber.org/mock v0.6.0 h1:hyF9dfmbgIX5EfOdasqLsWD6xqpNZlXblLB/Dbnwv3Y=
diff --git a/main.go b/main.go
index 0a95d6e..89b8c04 100644
--- a/main.go
+++ b/main.go
@@ -27,6 +27,10 @@ var VOTE_TOKEN = os.Getenv("VOTE_TOKEN")
var CONDITIONAL_GATEKEEP_URL = os.Getenv("VOTE_CONDITIONAL_URL")
var VOTE_HOST = os.Getenv("VOTE_HOST")
+// Dev mode flags
+var DEV_DISABLE_ACTIVE_FILTERS bool = os.Getenv("DEV_DISABLE_ACTIVE_FILTERS") == "true"
+var DEV_FORCE_IS_EVALS bool = os.Getenv("DEV_FORCE_IS_EVALS") == "true"
+
func inc(x int) string {
return strconv.Itoa(x + 1)
}
@@ -67,7 +71,7 @@ func main() {
r.GET("/auth/callback", csh.AuthCallback)
r.GET("/auth/logout", csh.AuthLogout)
- // TODO: change ALL the response codes to use http.(actual description)
+ // TODO: change ALL the response codes to use http.(actual description)
r.GET("/", csh.AuthWrapper(func(c *gin.Context) {
cl, _ := c.Get("cshauth")
claims := cl.(cshAuth.CSHClaims)
@@ -111,7 +115,7 @@ func main() {
r.GET("/create", csh.AuthWrapper(func(c *gin.Context) {
cl, _ := c.Get("cshauth")
claims := cl.(cshAuth.CSHClaims)
- if !slices.Contains(claims.UserInfo.Groups, "active") {
+ if !DEV_DISABLE_ACTIVE_FILTERS && !slices.Contains(claims.UserInfo.Groups, "active") {
c.HTML(403, "unauthorized.tmpl", gin.H{
"Username": claims.UserInfo.Username,
"FullName": claims.UserInfo.FullName,
@@ -122,14 +126,14 @@ func main() {
c.HTML(200, "create.tmpl", gin.H{
"Username": claims.UserInfo.Username,
"FullName": claims.UserInfo.FullName,
- "IsEvals": containsString(claims.UserInfo.Groups, "eboard-evaluations"),
+ "IsEvals": isEvals(claims.UserInfo),
})
}))
r.POST("/create", csh.AuthWrapper(func(c *gin.Context) {
cl, _ := c.Get("cshauth")
claims := cl.(cshAuth.CSHClaims)
- if !slices.Contains(claims.UserInfo.Groups, "active") {
+ if !DEV_DISABLE_ACTIVE_FILTERS && !slices.Contains(claims.UserInfo.Groups, "active") {
c.HTML(403, "unauthorized.tmpl", gin.H{
"Username": claims.UserInfo.Username,
"FullName": claims.UserInfo.FullName,
@@ -157,9 +161,9 @@ func main() {
OpenedTime: time.Now(),
Open: true,
QuorumType: quorum,
- Hidden: false,
Gatekeep: c.PostForm("gatekeep") == "true",
AllowWriteIns: c.PostForm("allowWriteIn") == "true",
+ Hidden: c.PostForm("hidden") == "true",
}
if c.PostForm("rankedChoice") == "true" {
poll.VoteType = database.POLL_TYPE_RANKED
@@ -183,7 +187,7 @@ func main() {
poll.Options = []string{"Pass", "Fail", "Abstain"}
}
if poll.Gatekeep {
- if !slices.Contains(claims.UserInfo.Groups, "eboard-evaluations") {
+ if !isEvals(claims.UserInfo) {
c.HTML(403, "unauthorized.tmpl", gin.H{
"Username": claims.UserInfo.Username,
"FullName": claims.UserInfo.FullName,
@@ -229,9 +233,6 @@ func main() {
}
canModify := containsString(claims.UserInfo.Groups, "active_rtp") || containsString(claims.UserInfo.Groups, "eboard") || poll.CreatedBy == claims.UserInfo.Username
- if poll.Gatekeep {
- canModify = false
- }
c.HTML(200, "poll.tmpl", gin.H{
"Id": poll.Id,
@@ -392,14 +393,6 @@ func main() {
return
}
- if poll.Hidden && poll.CreatedBy != claims.UserInfo.Username {
- c.HTML(403, "hidden.tmpl", gin.H{
- "Username": claims.UserInfo.Username,
- "FullName": claims.UserInfo.FullName,
- })
- return
- }
-
results, err := poll.GetResult(c)
if err != nil {
c.JSON(500, gin.H{"error": err.Error()})
@@ -407,9 +400,6 @@ func main() {
}
canModify := containsString(claims.UserInfo.Groups, "active_rtp") || containsString(claims.UserInfo.Groups, "eboard") || poll.CreatedBy == claims.UserInfo.Username
- if poll.Gatekeep {
- canModify = false
- }
c.HTML(200, "result.tmpl", gin.H{
"Id": poll.Id,
@@ -422,6 +412,7 @@ func main() {
"CanModify": canModify,
"Username": claims.UserInfo.Username,
"FullName": claims.UserInfo.FullName,
+ "Gatekeep": poll.Gatekeep,
})
}))
@@ -462,43 +453,6 @@ func main() {
c.Redirect(302, "/results/"+poll.Id)
}))
- r.POST("/poll/:id/reveal", csh.AuthWrapper(func(c *gin.Context) {
- cl, _ := c.Get("cshauth")
- claims := cl.(cshAuth.CSHClaims)
-
- poll, err := database.GetPoll(c, c.Param("id"))
- if err != nil {
- c.JSON(500, gin.H{"error": err.Error()})
- return
- }
-
- if poll.CreatedBy != claims.UserInfo.Username {
- c.JSON(403, gin.H{"error": "Only the creator can reveal a poll result"})
- return
- }
-
- err = poll.Reveal(c)
- if err != nil {
- c.JSON(500, gin.H{"error": err.Error()})
- return
- }
- pId, _ := primitive.ObjectIDFromHex(poll.Id)
- action := database.Action{
- Id: "",
- PollId: pId,
- Date: primitive.NewDateTimeFromTime(time.Now()),
- User: claims.UserInfo.Username,
- Action: "Reveal Results",
- }
- err = database.WriteAction(c, &action)
- if err != nil {
- c.JSON(500, gin.H{"error": err.Error()})
- return
- }
-
- c.Redirect(302, "/results/"+poll.Id)
- }))
-
r.POST("/poll/:id/close", csh.AuthWrapper(func(c *gin.Context) {
cl, _ := c.Get("cshauth")
claims := cl.(cshAuth.CSHClaims)
@@ -553,13 +507,18 @@ func main() {
r.Run()
}
+// isEvals determines if the current user is evals, allowing for a dev mode override
+func isEvals(user cshAuth.CSHUserInfo) bool {
+ return DEV_FORCE_IS_EVALS || containsString(user.Groups, "eboard-evaluations")
+}
+
// canVote determines whether a user can cast a vote.
//
// returns an integer value: 0 is success, 1 is database error, 3 is not active, 4 is gatekept, 9 is already voted
// TODO: use the return value to influence messages shown on results page
func canVote(user cshAuth.CSHUserInfo, poll database.Poll, allowedUsers []string) int {
// always false if user is not active
- if !slices.Contains(user.Groups, "active") {
+ if !DEV_DISABLE_ACTIVE_FILTERS && !slices.Contains(user.Groups, "active") {
return 3
}
voted, err := database.HasVoted(context.Background(), poll.Id, user.Username)
diff --git a/templates/create.tmpl b/templates/create.tmpl
index d892a3f..1fbeeba 100644
--- a/templates/create.tmpl
+++ b/templates/create.tmpl
@@ -72,6 +72,14 @@
>
Ranked Choice Vote
+
+
+ Hide Results Until Vote is Complete
+
{{ if .IsEvals }}
- Gatekeep Required
+ Gatekeep Required (Require Quorum, Limit Voters, Force Automatic Close)