Merge pull request #10 from mittwald/fix-optionals

make optional fields optional with native go types

.github/workflows/build.yml

@@ -33,7 +33,6 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v1
+        uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.27
-          args: --config=build/ci/.golangci.yml
+          version: v1.40.1

Makefile

@@ -1,8 +1,3 @@
-
-.PHONY: enable_transit
-enable_transit:
-	docker exec -ti vault vault secrets enable transit || echo "this is fine"
-
 .PHONY: test
 test:
 	go test -v -count=1 -failfast  ./...

client_test.go

@@ -2,7 +2,6 @@ package vault
 
 import (
 	"fmt"
-	"gopkg.in/guregu/null.v3"
 	"log"
 )
 
@@ -58,7 +57,7 @@ func Example_encryptDecryptType() {
 	key := "test123bacd"
 
 	err = transit.Create(key, &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 		Type:       rsa4096,
 	})
 	if err != nil {

test/testdata/container_vault.go

@@ -36,7 +36,7 @@ func InitVaultContainer(ctx context.Context) (*VaultContainer, error) {
 	token := "test"
 
 	req := testcontainers.ContainerRequest{
-		Image:        "vault:1.4.2",
+		Image:        "vault:1.6.2",
 		ExposedPorts: []string{string(port)},
 		WaitingFor:   wait.ForListeningPort(port),
 		Env: map[string]string{

transit.go

@@ -7,7 +7,6 @@ import (
 	"net/url"
 
 	"github.com/hashicorp/vault/api"
-	"gopkg.in/guregu/null.v3"
 )
 
 type Transit struct {
@@ -28,11 +27,11 @@ func (c *Client) TransitWithMountPoint(mountPoint string) *Transit {
 }
 
 type TransitCreateOptions struct {
-	ConvergentEncryption null.Bool `json:"convergent_encryption,omitempty"`
-	Derived              null.Bool `json:"derived,omitempty"`
-	Exportable           null.Bool `json:"exportable,omitempty"`
-	AllowPlaintextBackup null.Bool `json:"allow_plaintext_backup,omitempty"`
-	Type                 string    `json:"type,omitempty"`
+	ConvergentEncryption *bool  `json:"convergent_encryption,omitempty"`
+	Derived              *bool  `json:"derived,omitempty"`
+	Exportable           *bool  `json:"exportable,omitempty"`
+	AllowPlaintextBackup *bool  `json:"allow_plaintext_backup,omitempty"`
+	Type                 string `json:"type,omitempty"`
 }
 
 func (t *Transit) Create(key string, opts *TransitCreateOptions) error {
@@ -104,7 +103,7 @@ func (t *Transit) Delete(key string) error {
 
 func (t *Transit) ForceDelete(key string) error {
 	err := t.Update(key, TransitUpdateOptions{
-		DeletionAllowed: null.BoolFrom(true),
+		DeletionAllowed: BoolPtr(true),
 	})
 	if err != nil {
 		return err
@@ -114,11 +113,11 @@ func (t *Transit) ForceDelete(key string) error {
 }
 
 type TransitUpdateOptions struct {
-	MinDecryptionVersion int       `json:"min_decrytion_version"`
-	MinEncryptionVersion int       `json:"min_encryption_version"`
-	DeletionAllowed      null.Bool `json:"deletion_allowed"`
-	Exportable           null.Bool `json:"exportable"`
-	AllowPlaintextBackup null.Bool `json:"allow_plaintext_backup"`
+	MinDecryptionVersion int   `json:"min_decrytion_version,omitempty"`
+	MinEncryptionVersion int   `json:"min_encryption_version,omitempty"`
+	DeletionAllowed      *bool `json:"deletion_allowed,omitempty"`
+	Exportable           *bool `json:"exportable,omitempty"`
+	AllowPlaintextBackup *bool `json:"allow_plaintext_backup,omitempty"`
 }
 
 func (t *Transit) Update(key string, opts TransitUpdateOptions) error {
@@ -141,7 +140,7 @@ func (t *Transit) Rotate(key string) error {
 
 type TransitExportOptions struct {
 	KeyType string `json:"key_type"`
-	Version string `json:"version"`
+	Version string `json:"version,omitempty"`
 }
 
 type TransitExportResponse struct {
@@ -184,22 +183,22 @@ func (t *Transit) KeyExists(key string) (bool, error) {
 }
 
 type TransitBatchCiphertext struct {
-	Ciphertext string      `json:"ciphertext"`
-	Context    null.String `json:"context"`
+	Ciphertext string `json:"ciphertext"`
+	Context    string `json:"context,omitempty"`
 }
 
 type TransitBatchPlaintext struct {
-	Plaintext string      `json:"plaintext"`
-	Context   null.String `json:"context"`
+	Plaintext string `json:"plaintext"`
+	Context   string `json:"context,omitempty"`
 }
 
 type TransitEncryptOptions struct {
-	Plaintext            string      `json:"plaintext"`
-	Context              null.String `json:"context"`
-	KeyVersion           null.Int    `json:"key_version"`
-	Nonce                null.String `json:"nonce"`
-	Type                 null.String `json:"type"`
-	ConvergentEncryption null.String `json:"convergent_encryption"`
+	Plaintext            string `json:"plaintext"`
+	Context              string `json:"context,omitempty"`
+	KeyVersion           *int   `json:"key_version,omitempty"`
+	Nonce                string `json:"nonce,omitempty"`
+	Type                 string `json:"type,omitempty"`
+	ConvergentEncryption string `json:"convergent_encryption,omitempty"`
 }
 
 type TransitEncryptResponse struct {
@@ -223,9 +222,9 @@ func (t *Transit) Encrypt(key string, opts *TransitEncryptOptions) (*TransitEncr
 
 type TransitEncryptOptionsBatch struct {
 	BatchInput           []TransitBatchPlaintext `json:"batch_input"`
-	KeyVersion           null.Int                `json:"key_version"`
-	Type                 null.String             `json:"type"`
-	ConvergentEncryption null.String             `json:"convergent_encryption"`
+	KeyVersion           *int                    `json:"key_version,omitempty"`
+	Type                 string                  `json:"type,omitempty"`
+	ConvergentEncryption string                  `json:"convergent_encryption,omitempty"`
 }
 
 type TransitEncryptResponseBatch struct {
@@ -250,9 +249,9 @@ func (t *Transit) EncryptBatch(key string, opts *TransitEncryptOptionsBatch) (*T
 }
 
 type TransitDecryptOptions struct {
-	Ciphertext string      `json:"ciphertext"`
-	Context    null.String `json:"context"`
-	Nonce      null.String `json:"nonce"`
+	Ciphertext string `json:"ciphertext"`
+	Context    string `json:"context,omitempty"`
+	Nonce      string `json:"nonce,omitempty"`
 }
 
 type TransitDecryptResponse struct {

transit_test.go

@@ -10,7 +10,6 @@ import (
 
 	"github.com/hashicorp/vault/api"
 	"github.com/stretchr/testify/suite"
-	"gopkg.in/guregu/null.v3"
 )
 
 type TransitTestSuite struct {
@@ -33,19 +32,20 @@ func TestTransitTestSuite(t *testing.T) {
 
 func (s *TransitTestSuite) TestCreateAndRead() {
 	err := s.client.Create("testCreateAndRead", &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
 	res, err := s.client.Read("testCreateAndRead")
 	require.NoError(s.T(), err)
 
 	s.Equal(true, res.Data.Exportable)
+	s.T().Log(res.Data.Type)
 }
 
 func (s *TransitTestSuite) TestCreateAndList() {
 	err := s.client.Create("testCreateAndList", &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -61,7 +61,7 @@ func (s *TransitTestSuite) TestCreateAndList() {
 func (s *TransitTestSuite) TestCreateListAllowDelete() {
 	key := "testCreateListAllowDelete"
 	err := s.client.Create(key, &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -70,7 +70,7 @@ func (s *TransitTestSuite) TestCreateListAllowDelete() {
 	s.Contains(res.Data.Keys, key)
 
 	err = s.client.Update(key, TransitUpdateOptions{
-		DeletionAllowed: null.BoolFrom(true),
+		DeletionAllowed: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -85,7 +85,7 @@ func (s *TransitTestSuite) TestCreateListAllowDelete() {
 func (s *TransitTestSuite) TestCreateListForceDelete() {
 	key := "testCreateListForceDelete"
 	err := s.client.Create(key, &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -104,7 +104,7 @@ func (s *TransitTestSuite) TestCreateListForceDelete() {
 func (s *TransitTestSuite) TestRotate() {
 	key := "testRotate"
 	err := s.client.Create(key, &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -122,7 +122,7 @@ func (s *TransitTestSuite) TestRotate() {
 func (s *TransitTestSuite) TestExport() {
 	key := "testExport"
 	err := s.client.Create(key, &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -138,7 +138,7 @@ func (s *TransitTestSuite) TestExport() {
 
 func (s *TransitTestSuite) TestKeyExists() {
 	err := s.client.Create("testExists", &TransitCreateOptions{
-		Exportable: null.BoolFrom(true),
+		Exportable: BoolPtr(true),
 	})
 	require.NoError(s.T(), err)
 
@@ -198,6 +198,13 @@ func (s *TransitTestSuite) TestEncryptDecryptBatch() {
 	s.Equal(text2, dec.Data.BatchResults[1].Plaintext)
 }
 
+func (s *TransitTestSuite) TestImplicitEncryptCreate() {
+	_, err := s.client.Encrypt("test404", &TransitEncryptOptions{
+		Plaintext: "asdf",
+	})
+	require.NoError(s.T(), err)
+}
+
 func (s *TransitTestSuite) TestDecryptWithoutKey() {
 	_, err := s.client.Decrypt("test404", &TransitDecryptOptions{
 		Ciphertext: "asdf",

utils.go

@@ -11,3 +11,18 @@ func resolvePath(parts []string) string {
 
 	return "/" + strings.Join(trimmedParts, "/")
 }
+
+func BoolPtr(input bool) *bool {
+	b := input
+	return &b
+}
+
+func IntPtr(input int) *int {
+	i := input
+	return &i
+}
+
+func StringPtr(input string) *string {
+	s := input
+	return &s
+}