Merge pull request #559 from chainifynet/feature/cache

Caching Materials Manager and Memory cache implementation

Author: wobondar

.golangci.yml

@@ -59,7 +59,9 @@ linters:
     - zerologlint
 # enable these on the next golangci-lint release:
 #    - intrange
-
+    - fatcontext
+    - iface
+    - recvcheck
 linters-settings:
   errorlint:
     errorf: true

.mockery.yaml

@@ -2,8 +2,10 @@ with-expecter: true
 # remove 845 fix when V3 is released
 # https://vektra.github.io/mockery/latest/deprecations/#issue-845-fix
 issue-845-fix: true
+resolve-type-alias: false
 filename: "{{.InterfaceName}}_mock.go"
 mock-build-tags: "mocks"
+disable-version-string: false
 packages:
   github.com/chainifynet/aws-encryption-sdk-go/pkg/model:
     interfaces:
@@ -45,6 +47,9 @@ packages:
       GcmCrypter:
       AEADEncrypter:
       AEADDecrypter:
+      CacheEntry:
+      Cache:
+      CacheHasher:
   github.com/chainifynet/aws-encryption-sdk-go/pkg/model/format:
     interfaces:
       MessageAAD:

Makefile

@@ -14,19 +14,26 @@ SDK_PKGS=./pkg/...
 RUN_NONE=-run NOTHING
 RUN_INTEG=-run '^Test_Integration_'
 
+.DEFAULT_GOAL := help
+
+.PHONY: help
+help:	## Show the help menu
+	@echo "Usage: make <target>"
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
 .PHONY: all deps mocks mocks-build-tag vet lint lint-ci lint-local unit
 all: unit	## Run all the checks and tests
 	@echo "All checks and tests"
 
-deps:
+deps: ## Install development dependencies
 	@echo "Installing dependencies"
 	@go mod download -x all
 	@go install gotest.tools/gotestsum@latest
 	@go install github.com/golangci/golangci-lint/cmd/[email protected]
 	@go install github.com/vektra/mockery/[email protected]
 	@#go get github.com/stretchr/testify/[email protected]
 
-mocks:
+mocks: ## Generate mocks
 	@echo "Generating mocks"
 	@mockery
 	@#$(MAKE) mocks-build-tag
@@ -39,19 +46,21 @@ mocks-build-tag:
 		find ./mocks/ -name '*_mock.go' -exec sed -i '/^package/ i //go:build mocks\n' {} +; \
 	fi
 
-lint: mocks vet lint-ci
+lint: mocks vet lint-ci ## Generate mocks and run all linters
 
 lint-ci:
 	@echo "Running golangci-lint"
 	@golangci-lint run --build-tags=${CI_TAGS} --out-format=colored-line-number ./...
 
 lint-local:
 	@echo "Running golangci-lint locally"
+	@which golangci-lint
+	@golangci-lint --version
 	@golangci-lint run --build-tags=${CI_TAGS} ./...
 
 .PHONY: examples lint-examples run-examples
 
-examples: lint-examples run-examples
+examples: lint-examples run-examples ## Lint and run all examples
 
 lint-examples:
 	@for dir in $(shell find ./example -type d -mindepth 1 -maxdepth 1); do \
@@ -67,15 +76,15 @@ run-examples:
 		echo "================"; \
 	done
 
-vet:
+vet: ## Run go vet
 	@go vet ${BUILD_TAGS} --all ${SDK_PKGS}
 
 ##
 # Unit tests
 ##
 .PHONY: unit-race unit-pkg
 
-unit: lint unit-pkg
+unit: lint unit-pkg ## Run all unit tests
 
 unit-pkg:
 	@gotestsum -f ${GOTESTSUM_FMT} -- -timeout=4m ${BUILD_TAGS} ${SDK_PKGS}
@@ -90,9 +99,9 @@ unit-race:
 
 e2e: lint e2e-deps e2e-test-cli e2e-test-short
 
-e2e-test: e2e-test-cli e2e-test-short
+e2e-test: e2e-test-cli e2e-test-short	## Run e2e short integration tests
 
-e2e-deps:
+e2e-deps: ## Install e2e dependencies
 	@echo "Installing e2e dependencies"
 	@pip install aws-encryption-sdk-cli
 	@aws-encryption-cli --version
@@ -106,11 +115,11 @@ e2e-test-short:
 	@echo "Running e2e short tests"
 	@gotestsum -f ${GOTESTSUM_FMT} -- -short -timeout=10m -tags "integration" ${RUN_INTEG} ./test/e2e/...
 
-e2e-test-full:
+e2e-test-full: ## Run all e2e integration tests
 	@echo "Running full e2e tests, it will take a while"
 	@gotestsum -f ${GOTESTSUM_FMT} -- -timeout=15m -tags "integration" ${RUN_INTEG} ./test/e2e/...
 
-e2e-test-slow:
+e2e-test-slow: ## Run all slow e2e integration tests
 	@echo "Running very slow e2e tests"
 	@gotestsum -f testname -- -timeout=30m -tags "integration,slow" ${RUN_INTEG} ./test/e2e/...
 
@@ -120,12 +129,12 @@ e2e-test-slow:
 
 .PHONY: test-cover cover-html
 
-test-cover:
+test-cover:	## Run tests with coverage
 	@#CGO_ENABLED=1 go test -count=1 -coverpkg=./... -covermode=atomic -coverprofile coverage.out  ./...
 	@CGO_ENABLED=1 go test -timeout=10m -tags example,mocks,codegen,integration -cpu=2 -count=1 -coverpkg=./... -covermode=atomic -coverprofile=coverage.out ./pkg/...
 	@#CGO_ENABLED=1 go test -tags ${CI_TAGS} -count=1 -coverpkg=./... -covermode=atomic -coverprofile coverage.out ./pkg/...
 	@grep -v -E -f .covignore coverage.out > coverage.filtered.out
 	@mv coverage.filtered.out coverage.out
 
-cover-html:
+cover-html:	## Convert coverage to HTML report
 	@go tool cover -html=coverage.out -o coverage.html

README.md

@@ -1,12 +1,12 @@
 # AWS Encryption SDK for Go
 
+[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
 [![Go Unit](https://github.com/chainifynet/aws-encryption-sdk-go/actions/workflows/go-unit.yml/badge.svg?branch=main)](https://github.com/chainifynet/aws-encryption-sdk-go/actions/workflows/go-unit.yml)
 [![Go E2E](https://github.com/chainifynet/aws-encryption-sdk-go/actions/workflows/go-e2e.yml/badge.svg?branch=main)](https://github.com/chainifynet/aws-encryption-sdk-go/actions/workflows/go-e2e.yml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/chainifynet/aws-encryption-sdk-go)](https://goreportcard.com/report/github.com/chainifynet/aws-encryption-sdk-go)
 [![codecov](https://codecov.io/gh/chainifynet/aws-encryption-sdk-go/graph/badge.svg?token=YPZT7IOJMM)](https://codecov.io/gh/chainifynet/aws-encryption-sdk-go)
 ![Code style: gofmt](https://img.shields.io/badge/code_style-gofmt-00ADD8.svg)
 [![Go Reference](https://pkg.go.dev/badge/github.com/chainifynet/aws-encryption-sdk-go.svg)](https://pkg.go.dev/github.com/chainifynet/aws-encryption-sdk-go)
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fchainifynet%2Faws-encryption-sdk-go.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fchainifynet%2Faws-encryption-sdk-go?ref=badge_shield)
 
 This project is an implementation of the [AWS Encryption SDK](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/reference.html) for the Go programming language, providing a set of libraries for developers to easily add encryption and decryption functionality to their Go applications. This implementation is inspired by the [aws-encryption-sdk-python](https://github.com/aws/aws-encryption-sdk-python) and follows the [AWS Encryption SDK specification](https://github.com/awslabs/aws-encryption-sdk-specification/tree/c35fbd91b28303d69813119088c44b5006395eb4) closely.
 
@@ -26,7 +26,6 @@ This SDK aims to fill that gap, offering Go developers the tools to implement en
 
 ### Current Limitations
 
-- Does not support the Caching Materials Manager feature yet.
 - Does not support KMS aliases at this stage.
 - Raw Master Key provider does not support RSA encryption.
 - Only framed content type is supported.
@@ -187,7 +186,7 @@ if err != nil {
 
 ## TODO
 
-- [ ] Add support for Caching Materials Manager.
+- [x] Add support for Caching Materials Manager [#559](https://github.com/chainifynet/aws-encryption-sdk-go/pull/559).
 - [x] Add support for Message Format Version 1 [#170](https://github.com/chainifynet/aws-encryption-sdk-go/pull/170).
 - [x] Add support for AWS KMS Multi-Region Keys [#46](https://github.com/chainifynet/aws-encryption-sdk-go/pull/46).
 - [ ] Add support for KMS aliases.