Merge branch 'gofiber:main' into main

.github/workflows/codeql-analysis.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         # We must fetch at least the immediate parents so that if this is
         # a pull request then we can checkout the head.

.github/workflows/golangci-lint.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Fetch Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Run golangci-lint
         uses: reviewdog/action-golangci-lint@v2
         with:

.github/workflows/gosec.yml

@@ -26,7 +26,7 @@ jobs:
       GO111MODULE: on
     steps:
       - name: Fetch Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Go
         uses: actions/setup-go@v4
         with:

.github/workflows/govulncheck.yml

@@ -26,7 +26,7 @@ jobs:
       GO111MODULE: on
     steps:
     - name: Fetch Repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Install Go
       uses: actions/setup-go@v4
       with:

.github/workflows/sync-docs.yml

@@ -17,7 +17,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   ref: ${{ github.event.pull_request.head.sha }}
                   fetch-depth: 2

.github/workflows/test-arangodb.yml

@@ -27,7 +27,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-azureblob.yml

@@ -23,7 +23,7 @@ jobs:
             run: |
                 docker run -d -p 10000:10000 mcr.microsoft.com/azure-storage/azurite azurite-blob --blobHost 0.0.0.0 --blobPort 10000
         -   name: Fetch Repository
-            uses: actions/checkout@v3
+            uses: actions/checkout@v4
         -   name: Install Go
             uses: actions/setup-go@v4
             with:

.github/workflows/test-badger.yml

@@ -20,7 +20,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-bbolt.yml

@@ -20,7 +20,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-coherence.yml

@@ -20,7 +20,7 @@ jobs:
           - 1.21.x
     steps:
       - name: Fetch Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Startup Coherence
         run: |
           docker run -d -p 1408:1408 -p 30000:30000 ghcr.io/oracle/coherence-ce:22.06.5

.github/workflows/test-couchbase.yml

@@ -20,7 +20,7 @@ jobs:
           - 1.21.x
     steps:
       - name: Fetch Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install couchbase
         run: |
           docker run --name couchbase -d -p 8091-8097:8091-8097 -p 9123:9123 -p 11207:11207 -p 11210:11210 -p 11280:11280 -p 18091-18097:18091-18097 couchbase:enterprise-7.1.1

.github/workflows/test-dynamodb.yml

@@ -25,7 +25,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-etcd.yml

@@ -20,7 +20,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install etcd
                 run: |
                     docker run -d --name Etcd-server \

.github/workflows/test-memcache.yml

@@ -25,7 +25,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-memory.yml

@@ -20,7 +20,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-minio.yml

@@ -24,7 +24,7 @@ jobs:
                     docker run -d --restart always -p 9000:9000 --name storage-minio -e MINIO_ROOT_USER='minio-user' -e MINIO_ROOT_PASSWORD='minio-password' minio/minio server /data
 
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-mongodb.yml

@@ -25,7 +25,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-mssql.yml

@@ -37,7 +37,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-mysql.yml

@@ -33,7 +33,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-pebble.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     -   name: Fetch Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
     -   name: Install Go
         uses: actions/setup-go@v4
         with:

.github/workflows/test-postgres.yml

@@ -32,7 +32,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-redis.yml

@@ -23,7 +23,7 @@ jobs:
                     - '7.x'
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
 
             -   name: Setup Redis
                 uses: shogo82148/actions-setup-redis@v1

.github/workflows/test-ristretto.yml

@@ -20,7 +20,7 @@ jobs:
                     - 1.21.x
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

.github/workflows/test-rueidis.yml

@@ -22,7 +22,7 @@ jobs:
                     - '7.x'
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
 
             -   name: Generate TLS certs
                 run: ./.github/scripts/gen-test-certs.sh

.github/workflows/test-s3.yml

@@ -20,16 +20,9 @@ jobs:
                     - 1.21.x
         steps:
         -   name: Install MinIO
-            run: |
-                docker run -d -p 9000:9000 --name minio minio/minio server /data
-
-                export AWS_ACCESS_KEY_ID=minioadmin
-                export AWS_SECRET_ACCESS_KEY=minioadmin
-                export AWS_EC2_METADATA_DISABLED=true
-
-                aws --endpoint-url http://127.0.0.1:9000/ s3 mb s3://testbucket
+            run: docker run -d -p 9000:9000 --name minio minio/minio server /data
         -   name: Fetch Repository
-            uses: actions/checkout@v3
+            uses: actions/checkout@v4
         -   name: Install Go
             uses: actions/setup-go@v4
             with:

.github/workflows/test-sqlite3.yml

@@ -20,7 +20,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             -   name: Fetch Repository
-                uses: actions/checkout@v3
+                uses: actions/checkout@v4
             -   name: Install Go
                 uses: actions/setup-go@v4
                 with:

coherence/coherence.go

@@ -12,7 +12,7 @@ import (
 
 const (
 	defaultScopeName = "default-store"
-	defaultTimeout   = time.Duration(30) * time.Millisecond
+	defaultTimeout   = time.Duration(30) * time.Second
 )
 
 // Storage represents an implementation of Coherence storage provider.

s3/README.md

@@ -31,8 +31,15 @@ func (s *Storage) Delete(key string) error
 func (s *Storage) Reset() error
 func (s *Storage) Close() error
 func (s *Storage) Conn() *s3.Client
+
+// Additional useful methods.
+func (s *Storage) CreateBucker(bucket string) error
+func (s *Storage) DeleteBucket(bucket string) error
+func (s *Storage) SetWithChecksum(key string, val []byte, checksum map[types.ChecksumAlgorithm][]byte) error
 ```
+
 ### Installation
+
 S3 is tested on the 2 last [Go versions](https://golang.org/dl/) with support for modules. So make sure to initialize one first if you didn't do that yet:
 ```bash
 go mod init github.com/<user>/<repo>
@@ -43,7 +50,9 @@ go get github.com/gofiber/storage/s3/v2
 ```
 
 ### Examples
+
 Import the storage package.
+
 ```go
 import "github.com/gofiber/storage/s3/v2"
 ```
@@ -62,6 +71,38 @@ store := s3.New(s3.Config{
 })
 ```
 
+Create an object with `Set()`:
+```go
+err := store.Set("my-key", []byte("my-value"))
+```
+
+Or, call `SetWithChecksum()` to create an object with checksum to
+ask S3 server to verify data integrity on server side:
+
+> Currently 4 algorithms are supported:
+>   - types.ChecksumAlgorithmCrc32 (`CRC32`)
+>   - types.ChecksumAlgorithmCrc32c (`CRC32C`)
+>   - types.ChecksumAlgorithmSha1 (`SHA1`)
+>   - types.ChecksumAlgorithmSha256 (`SHA256`)
+>
+> For more information, see [PutObjectInput](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3#PutObjectInput).
+
+```go
+key := "my-key"
+val := []byte("my-value")
+
+hash := sha256.New()
+hash.Write(val)
+sha256sum := hash.Sum(nil)
+
+// import "github.com/aws/aws-sdk-go-v2/service/s3/types"
+checksum  = map[types.ChecksumAlgorithm][]byte{
+    types.ChecksumAlgorithmSha256: sha256sum,
+}
+
+err := store.SetWithChecksum(key, val, checksum)
+```
+
 ### Config
 ```go
 // Config defines the config for storage.
@@ -104,7 +145,9 @@ type Credentials struct {
 ```
 
 ### Default Config
+
 The default configuration lacks Bucket, Region, and Endpoint which are all required and must be overwritten:
+
 ```go
 // ConfigDefault is the default config
 var ConfigDefault = Config{

s3/init_test.go

@@ -0,0 +1,38 @@
+package s3
+
+import (
+	"os"
+	"testing"
+	"time"
+)
+
+const (
+	bucket = "testbucket"
+)
+
+var testStore *Storage
+
+func TestMain(m *testing.M) {
+	testStore = New(
+		Config{
+			Bucket:   bucket,
+			Endpoint: "http://127.0.0.1:9000/",
+			Region:   "us-east-1",
+			Credentials: Credentials{
+				AccessKey:       "minioadmin",
+				SecretAccessKey: "minioadmin",
+			},
+			RequestTimeout: 3 * time.Second,
+		},
+	)
+
+	// Create test bucket.
+	_ = testStore.CreateBucket(bucket)
+
+	exitVal := m.Run()
+
+	// Delete test bucket.
+	_ = testStore.DeleteBucket(bucket)
+
+	os.Exit(exitVal)
+}

s3/s3.go

@@ -159,7 +159,7 @@ func (s *Storage) Close() error {
 	return nil
 }
 
-// Return database client
+// Conn returns database client.
 func (s *Storage) Conn() *s3.Client {
 	return s.svc
 }
@@ -186,11 +186,11 @@ func returnAWSConfig(cfg Config) (aws.Config, error) {
 	})
 
 	if cfg.Credentials != (Credentials{}) {
-		credentials := credentials.NewStaticCredentialsProvider(cfg.Credentials.AccessKey, cfg.Credentials.SecretAccessKey, "")
+		creds := credentials.NewStaticCredentialsProvider(cfg.Credentials.AccessKey, cfg.Credentials.SecretAccessKey, "")
 		return awsconfig.LoadDefaultConfig(context.TODO(),
 			awsconfig.WithRegion(cfg.Region),
 			awsconfig.WithEndpointResolverWithOptions(endpoint),
-			awsconfig.WithCredentialsProvider(credentials),
+			awsconfig.WithCredentialsProvider(creds),
 			awsconfig.WithRetryer(func() aws.Retryer {
 				return retry.AddWithMaxAttempts(retry.NewStandard(), cfg.MaxAttempts)
 			}),