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

     1  package documentdb
     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/documentdb"
    11  	"github.com/khulnasoft-lab/defsec/pkg/scan"
    12  
    13  	"github.com/stretchr/testify/assert"
    14  )
    15  
    16  func TestCheckEnableLogExport(t *testing.T) {
    17  	tests := []struct {
    18  		name     string
    19  		input    documentdb.DocumentDB
    20  		expected bool
    21  	}{
    22  		{
    23  			name: "DocDB Cluster not exporting logs",
    24  			input: documentdb.DocumentDB{
    25  				Clusters: []documentdb.Cluster{
    26  					{
    27  						Metadata: defsecTypes.NewTestMetadata(),
    28  						EnabledLogExports: []defsecTypes.StringValue{
    29  							defsecTypes.String("", defsecTypes.NewTestMetadata()),
    30  						},
    31  					},
    32  				},
    33  			},
    34  			expected: true,
    35  		},
    36  		{
    37  			name: "DocDB Cluster exporting audit logs",
    38  			input: documentdb.DocumentDB{
    39  				Clusters: []documentdb.Cluster{
    40  					{
    41  						Metadata: defsecTypes.NewTestMetadata(),
    42  						EnabledLogExports: []defsecTypes.StringValue{
    43  							defsecTypes.String(documentdb.LogExportAudit, defsecTypes.NewTestMetadata()),
    44  						},
    45  					},
    46  				},
    47  			},
    48  			expected: false,
    49  		},
    50  		{
    51  			name: "DocDB Cluster exporting profiler logs",
    52  			input: documentdb.DocumentDB{
    53  				Clusters: []documentdb.Cluster{
    54  					{
    55  						Metadata: defsecTypes.NewTestMetadata(),
    56  						EnabledLogExports: []defsecTypes.StringValue{
    57  							defsecTypes.String(documentdb.LogExportProfiler, defsecTypes.NewTestMetadata()),
    58  						},
    59  					},
    60  				},
    61  			},
    62  			expected: false,
    63  		},
    64  	}
    65  	for _, test := range tests {
    66  		t.Run(test.name, func(t *testing.T) {
    67  			var testState state.State
    68  			testState.AWS.DocumentDB = test.input
    69  			results := CheckEnableLogExport.Evaluate(&testState)
    70  			var found bool
    71  			for _, result := range results {
    72  				if result.Status() == scan.StatusFailed && result.Rule().LongID() == CheckEnableLogExport.Rule().LongID() {
    73  					found = true
    74  				}
    75  			}
    76  			if test.expected {
    77  				assert.True(t, found, "Rule should have been found")
    78  			} else {
    79  				assert.False(t, found, "Rule should not have been found")
    80  			}
    81  		})
    82  	}
    83  }