Update go version, add tools for verification and testing (#100)

Fixes # **Summary of Changes** 1. 2. 3. > PS: Make sure your PR includes/updates tests! If you need help with this part, just ask!
1 year ago · 622c352f28
12 changed files with 165 additions and 126 deletions
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@ -1,60 +0,0 @@
-version: 2.0
-
-jobs:
-  # Base test configuration for Go library tests Each distinct version should
-  # inherit this base, and override (at least) the container image used.
-  "test": &test
-    docker:
-      - image: circleci/golang:latest
-    working_directory: /go/src/github.com/gorilla/feeds
-    steps: &steps
-      - checkout
-      - run: go version
-      - run: go get -t -v ./...
-      - run: diff -u <(echo -n) <(gofmt -d .)
-      - run: if [[ "$LATEST" = true ]]; then go vet -v .; fi
-      - run: go test -v -race ./...
-
-  "latest":
-    <<: *test
-    environment:
-      LATEST: true
-
-
-  "1.12":
-    <<: *test
-    docker:
-      - image: circleci/golang:1.12
-
-  "1.11":
-    <<: *test
-    docker:
-      - image: circleci/golang:1.11
-
-  "1.10":
-    <<: *test
-    docker:
-      - image: circleci/golang:1.10
-
-  "1.9":
-    <<: *test
-    docker:
-      - image: circleci/golang:1.9
-
-  "1.8":
-    <<: *test
-    docker:
-      - image: circleci/golang:1.8
-
-
-
-workflows:
-  version: 2
-  build:
-    jobs:
-      - "latest"
-      - "1.12"
-      - "1.11"
-      - "1.10"
-      - "1.9"
-      - "1.8"
--- a/.github/stale.yml
+++ b/.github/stale.yml
@ -1,12 +0,0 @@
-daysUntilStale: 60
-daysUntilClose: 7
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - v2
-  - needs-review
-  - work-required
-staleLabel: stale
-markComment: >
-  This issue has been automatically marked as stale because it hasn't seen
-  a recent update. It'll be automatically closed in a few days.
-closeComment: false
--- a/.github/workflows/issues.yml
+++ b/.github/workflows/issues.yml
@ -0,0 +1,20 @@
+# Add all the issues created to the project.
+name: Add issue or pull request to Project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add issue to project
+        uses: actions/add-to-project@v0.5.0
+        with:
+          project-url: https://github.com/orgs/gorilla/projects/4
+          github-token: ${{ secrets.ADD_TO_PROJECT_TOKEN }}
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@ -0,0 +1,55 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  verify-and-test:
+    strategy:
+      matrix:
+        go: ['1.19','1.20']
+        os: [ubuntu-latest, macos-latest, windows-latest]
+      fail-fast: true
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Setup Go ${{ matrix.go }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go }}
+          cache: false
+
+      - name: Run GolangCI-Lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.53
+          args: --timeout=5m
+
+      - name: Run GoSec
+        if: matrix.os == 'ubuntu-latest'
+        uses: securego/gosec@master
+        with:
+          args: ./...
+
+      - name: Run GoVulnCheck
+        uses: golang/govulncheck-action@v1
+        with:
+          go-version-input: ${{ matrix.go }}
+          go-package: ./...
+
+      - name: Run Tests
+        run: go test -race -cover -coverprofile=coverage -covermode=atomic -v ./...
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1 @@
+coverage.coverprofile
--- a/29
+++ b/29
@ -1,29 +0,0 @@
-# This is the official list of gorilla/feeds authors for copyright purposes.
-# Please keep the list sorted.
-
-Dmitry Chestnykh <dmitry@codingrobots.com>
-Eddie Scholtz <eascholtz@gmail.com>
-Gabriel Simmer <bladesimmer@gmail.com>
-Google LLC (https://opensource.google.com/)
-honky <honky@defendtheplanet.net>
-James Gregory <james@jagregory.com>
-Jason Hall <imjasonh@gmail.com>
-Jason Moiron <jmoiron@jmoiron.net>
-Kamil Kisiel <kamil@kamilkisiel.net>
-Kevin Stock <kevinstock@tantalic.com>
-Markus Zimmermann <markus.zimmermann@nethead.at>
-Matt Silverlock <matt@eatsleeprepeat.net>
-Matthew Dawson <matthew@mjdsystems.ca>
-Milan Aleksic <milanaleksic@gmail.com>
-Milan Aleksić <milanaleksic@gmail.com>
-nlimpid <jshuangzl@gmail.com>
-Paul Petring <paul@defendtheplanet.net>
-Sean Enck <enckse@users.noreply.github.com>
-Sue Spence <virtuallysue@gmail.com>
-Supermighty <ukiah@faction.com>
-Toru Fukui <fukuimone@gmail.com>
-Vabd <vabd@anon.acme>
-Volker <lists.volker@gmail.com>
-ZhiFeng Hu <hufeng1987@gmail.com>
-weberc2 <weberc2@gmail.com>
-
--- a/40
+++ b/40
@ -1,22 +1,28 @@
-Copyright (c) 2013-2018 The Gorilla Feeds Authors. All rights reserved.
+Copyright (c) 2023 The Gorilla Authors. All rights reserved.

 Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+modification, are permitted provided that the following conditions are
+met:

-  Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+	 * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+	 * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+	 * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.

-  Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
--- a/34
+++ b/34
@ -0,0 +1,34 @@
+GO_LINT=$(shell which golangci-lint 2> /dev/null || echo '')
+GO_LINT_URI=github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
+GO_SEC=$(shell which gosec 2> /dev/null || echo '')
+GO_SEC_URI=github.com/securego/gosec/v2/cmd/gosec@latest
+
+GO_VULNCHECK=$(shell which govulncheck 2> /dev/null || echo '')
+GO_VULNCHECK_URI=golang.org/x/vuln/cmd/govulncheck@latest
+
+.PHONY: golangci-lint
+golangci-lint:
+	$(if $(GO_LINT), ,go install $(GO_LINT_URI))
+	@echo "##### Running golangci-lint"
+	golangci-lint run -v
+
+.PHONY: gosec
+gosec:
+	$(if $(GO_SEC), ,go install $(GO_SEC_URI))
+	@echo "##### Running gosec"
+	gosec ./...
+
+.PHONY: govulncheck
+govulncheck:
+	$(if $(GO_VULNCHECK), ,go install $(GO_VULNCHECK_URI))
+	@echo "##### Running govulncheck"
+	govulncheck ./...
+
+.PHONY: verify
+verify: golangci-lint gosec govulncheck
+
+.PHONY: test
+test:
+	@echo "##### Running tests"
+	go test -race -cover -coverprofile=coverage.coverprofile -covermode=atomic -v ./...
--- a/README.md
+++ b/README.md
@ -1,7 +1,10 @@
 ## gorilla/feeds
-[![GoDoc](https://godoc.org/github.com/gorilla/feeds?status.svg)](https://godoc.org/github.com/gorilla/feeds)
-[![CircleCI](https://circleci.com/gh/gorilla/feeds.svg?style=svg)](https://circleci.com/gh/gorilla/feeds)
+![testing](https://github.com/gorilla/feeds/actions/workflows/test.yml/badge.svg)
+[![codecov](https://codecov.io/github/gorilla/feeds/branch/main/graph/badge.svg)](https://codecov.io/github/gorilla/feeds)
+[![godoc](https://godoc.org/github.com/gorilla/feeds?status.svg)](https://godoc.org/github.com/gorilla/feeds)
+[![sourcegraph](https://sourcegraph.com/github.com/gorilla/feeds/-/badge.svg)](https://sourcegraph.com/github.com/gorilla/feeds?badge)

+![Gorilla Logo](https://github.com/gorilla/.github/assets/53367916/d92caabf-98e0-473e-bfbf-ab554ba435e5)

 feeds is a web feed generator library for generating RSS, Atom and JSON feeds from Go
 applications.
@ -183,4 +186,3 @@ Outputs:
  ]
 }
 ```
-
--- a/consume_test.go
+++ b/consume_test.go
@ -2,7 +2,7 @@ package feeds

 import (
 	"encoding/xml"
-	"io/ioutil"
+	"io"
 	"os"
 	"reflect"
 	"testing"
@ -373,8 +373,10 @@ func TestRssUnmarshal(t *testing.T) {
 	if err != nil {
 		panic("AHH file bad")
 	}
-	bytes, _ := ioutil.ReadAll(xmlFile)
-	xml.Unmarshal(bytes, &xmlFeed)
+	bytes, _ := io.ReadAll(xmlFile)
+	if err := xml.Unmarshal(bytes, &xmlFeed); err != nil {
+		panic(err)
+	}

 	if !reflect.DeepEqual(testRssFeedXML, xmlFeed) {
 		diffs := pretty.Diff(testRssFeedXML, xmlFeed)
@ -390,8 +392,10 @@ func TestAtomUnmarshal(t *testing.T) {
 	if err != nil {
 		panic("AHH file bad")
 	}
-	bytes, _ := ioutil.ReadAll(xmlFile)
-	xml.Unmarshal(bytes, &xmlFeed)
+	bytes, _ := io.ReadAll(xmlFile)
+	if err := xml.Unmarshal(bytes, &xmlFeed); err != nil {
+		panic(err)
+	}

 	if !reflect.DeepEqual(testAtomFeedXML, xmlFeed) {
 		diffs := pretty.Diff(testAtomFeedXML, xmlFeed)
--- a/go.mod
+++ b/go.mod
@ -0,0 +1,10 @@
+module github.com/gorilla/feeds
+
+go 1.19
+
+require github.com/kr/pretty v0.3.1
+
+require (
+	github.com/kr/text v0.2.0 // indirect
+	github.com/rogpeppe/go-internal v1.9.0 // indirect
+)
--- a/go.sum
+++ b/go.sum
@ -0,0 +1,8 @@
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
+github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
+github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=