Add tests for documentation and contributing info

- Added tests in CI for testing the documentation changes not committed

  Closes #14

- Add details for contributing to the project CONTRIBUTING.md

Signed-off-by: Kairo Araujo <kairo@kairo.eti.br>

.github/workflows/goca-tests.yml

@@ -24,12 +24,3 @@ jobs:
 
     - name: Test
       run: make test
-
-    # TODO: Implement a more consistent test for the docs issue #14
-    # - name: Check if API Docs are updated
-    #   run: |
-    #     export PATH=$PATH:$(go env GOPATH)/bin
-    #     cd rest-api
-    #     make doc
-    #     api_docs=$(git diff --name-only | grep ^docs || true )
-    #     if [[ $api_docs != "" ]]; then echo $api_docs; exit 1; fi

.gitignore

@@ -3,3 +3,4 @@ bin/
 count.out
 coverage.out
 DoNotUseThisCAPATHTestOnly/
+docs-test/

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+## How to contribute to GoCA
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/kairoaraujo/goca/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/kairoaraujo/goca/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+
+#### **Did you write a patch that fixes a bug?**
+
+* Update the documentation and run tests
+
+  - Update the documentation
+
+    ```shell
+    make docs
+    ```
+
+  - Run the tests
+
+    ```shell
+    make docs
+    ```
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change in the opening a [new issue](https://github.com/kairoaraujo/goca/issues/new) to discuss the details.
+
+
+Thanks! :heart:
+
+GoCA Team

Makefile

@@ -1,14 +1,21 @@
-lint:
-	if [ ! -f ./bin/golangci-lint ] ; \
-	then \
-		curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.32.2; \
-	fi;
-	./bin/golangci-lint run -e gosec
+.PHONY: test docs docker-image
 
 test:
-	go test -covermode=count -coverprofile=count.out -v ./...
+	go test -covermode=count -coverprofile=count.out -v $(go list ./... | grep -v /docs-test/)
+
+	export PATH=$$PATH:`go env GOPATH`/bin; make -C rest-api test-doc
+	diff docs-test/swagger.json docs/swagger.json
+	diff docs-test/swagger.yaml docs/swagger.yaml
+
+docs:
+	export PATH=$$PATH:`go env GOPATH`/bin; make -C rest-api doc
 
 docker-image:
 	docker build -t goca-rest-api:latest .
 
-.PHONY: lint test mock
+lint:
+	if [ ! -f ./bin/golangci-lint ] ; \
+	then \
+		curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.49.0; \
+	fi;
+	./bin/golangci-lint run -e gosec

README.md

@@ -17,9 +17,11 @@ Certificates Request List (CRL).
 
 **Content**:
 
-- [GoCA Docker Container](#GoCA-Docker-Container)
-- [GoCA Package](#GoCA-Package)
-- [GoCA HTTP REST API package](#GoCA-HTTP-REST-API)
+- [Go Certificate Authority management package](#go-certificate-authority-management-package)
+  - [GoCA Package](#goca-package)
+  - [GoCA HTTP REST API](#goca-http-rest-api)
+  - [GoCA Docker Container](#goca-docker-container)
+- [Contributing](#contributing)
 
 ## GoCA Package
 
@@ -133,3 +135,7 @@ The API Documentation is online available at http://kairoaraujo.github.io/goca/.
 More details in [Docker README](DOCKER_README.md).
 
 GoCA Docker Image is available at https://hub.docker.com/r/kairoaraujo/goca/
+
+# Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).

rest-api/Makefile

@@ -1,9 +1,14 @@
+.PHONY: check_swag doc test-doc run build
+
 check_swag:
 	which swag || GO111MODULE=off go get -u github.com/swaggo/swag/cmd/swag
 
 doc: check_swag
 	swag init --output ../docs/ -parseDependency=true
 
+test-doc:
+	swag init --output ../docs-test/ -parseDependency=true
+
 run:
 	go run main.go