github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/aws/s3/enable_bucket_logging_test.go (about)

     1  package s3
     2  
     3  import (
     4  	"testing"
     5  
     6  	defsecTypes "github.com/khulnasoft-lab/defsec/pkg/types"
     7  
     8  	"github.com/khulnasoft-lab/defsec/pkg/state"
     9  
    10  	"github.com/khulnasoft-lab/defsec/pkg/providers/aws/s3"
    11  	"github.com/khulnasoft-lab/defsec/pkg/scan"
    12  
    13  	"github.com/stretchr/testify/assert"
    14  )
    15  
    16  func TestCheckLoggingIsEnabled(t *testing.T) {
    17  	tests := []struct {
    18  		name     string
    19  		input    s3.S3
    20  		expected bool
    21  	}{
    22  		{
    23  			name: "S3 bucket logging disabled",
    24  			input: s3.S3{
    25  				Buckets: []s3.Bucket{
    26  					{
    27  						Metadata: defsecTypes.NewTestMetadata(),
    28  						ACL:      defsecTypes.String("private", defsecTypes.NewTestMetadata()),
    29  						Logging: s3.Logging{
    30  							Metadata: defsecTypes.NewTestMetadata(),
    31  							Enabled:  defsecTypes.Bool(false, defsecTypes.NewTestMetadata()),
    32  						},
    33  					},
    34  				},
    35  			},
    36  			expected: true,
    37  		},
    38  		{
    39  			name: "S3 bucket logging enabled",
    40  			input: s3.S3{
    41  				Buckets: []s3.Bucket{
    42  					{
    43  						Metadata: defsecTypes.NewTestMetadata(),
    44  						ACL:      defsecTypes.String("log-delivery-write", defsecTypes.NewTestMetadata()),
    45  						Logging: s3.Logging{
    46  							Metadata: defsecTypes.NewTestMetadata(),
    47  							Enabled:  defsecTypes.Bool(true, defsecTypes.NewTestMetadata()),
    48  						},
    49  					},
    50  				},
    51  			},
    52  			expected: false,
    53  		},
    54  	}
    55  	for _, test := range tests {
    56  		t.Run(test.name, func(t *testing.T) {
    57  			var testState state.State
    58  			testState.AWS.S3 = test.input
    59  			results := CheckLoggingIsEnabled.Evaluate(&testState)
    60  			var found bool
    61  			for _, result := range results {
    62  				if result.Status() == scan.StatusFailed && result.Rule().LongID() == CheckLoggingIsEnabled.Rule().LongID() {
    63  					found = true
    64  				}
    65  			}
    66  			if test.expected {
    67  				assert.True(t, found, "Rule should have been found")
    68  			} else {
    69  				assert.False(t, found, "Rule should not have been found")
    70  			}
    71  		})
    72  	}
    73  }