@terra-graph/conventions-aws 1.0.0-rc.1

package/dist/esm/plugins/AwsIam.js

@@ -0,0 +1,428 @@
+import { ConvertNodeToEdge, EdgeReverse, GraphPlugin, NodeProperties, RemoveLeafChain, RemoveNodeAndReconnectEdges, } from '@terra-graph/core';
+import { pluginId } from '../namespaces.js';
+export const AWS_IAM_PLUGIN_MODES = ['roles_only', 'roles_policies', 'full'];
+export const AWS_IAM_ATTACHMENT_MODES = ['remove', 'convert_to_edge', 'keep'];
+export const AWS_IAM_POLICY_DOCUMENT_MODES = ['none', 'trust_only', 'all'];
+const IAM_ROLE_RESOURCES = ['aws_iam_role'];
+const IAM_POLICY_RESOURCES = ['aws_iam_policy', 'aws_iam_role_policy'];
+const IAM_ATTACHMENT_RESOURCES = ['aws_iam_role_policy_attachment', 'aws_iam_policy_attachment'];
+const IAM_POLICY_DOCUMENT_RESOURCE = 'aws_iam_policy_document';
+const IAM_DATA_POLICY_RESOURCE = 'aws_iam_policy';
+const IAM_ORPHAN_PRUNABLE_RESOURCES = [
+    ...IAM_ROLE_RESOURCES,
+    ...IAM_POLICY_RESOURCES,
+    ...IAM_ATTACHMENT_RESOURCES,
+];
+const IAM_ORPHAN_PRUNABLE_DATA_RESOURCES = [IAM_POLICY_DOCUMENT_RESOURCE, IAM_DATA_POLICY_RESOURCE];
+export class AwsIamGraphPlugin extends GraphPlugin {
+    static id = pluginId(`aws.${AwsIamGraphPlugin.name}`);
+    constructor() {
+        super(AwsIamGraphPlugin.id, {
+            mode: 'roles_only',
+        });
+    }
+    build({ options, }) {
+        const resolved = this.resolveOptions(options);
+        const phases = [
+            ...this.toPhases('normalize', this.buildIamDirectionPhases()),
+            ...this.toPhases('main', this.buildIamLabelHintPhases()),
+            ...this.toPhases('main', this.buildAttachmentPhases(resolved)),
+        ];
+        if (resolved.mode !== 'full') {
+            phases.push(...this.toPhases('main', [
+                [
+                    new RemoveNodeAndReconnectEdges({
+                        node: {
+                            and: [
+                                {
+                                    attr: {
+                                        key: 'terraform.resource',
+                                        startsWith: 'aws_iam_',
+                                    },
+                                },
+                                {
+                                    not: {
+                                        attr: {
+                                            key: 'terraform.resource',
+                                            in: this.buildKeepResourcesForMode(resolved),
+                                        },
+                                    },
+                                },
+                            ],
+                        },
+                    }),
+                ],
+            ]));
+            if (resolved.policyDocuments === 'trust_only') {
+                phases.push(...this.toPhases('main', this.buildPolicyDocumentPhases(resolved)));
+            }
+            phases.push(...this.buildCleanupPhases(resolved));
+            return { phases };
+        }
+        phases.push(...this.toPhases('main', this.buildPolicyDocumentPhases(resolved)));
+        phases.push(...this.buildCleanupPhases(resolved));
+        return { phases };
+    }
+    toPhases(phase, phases) {
+        return phases.map((rules) => ({ phase, rules }));
+    }
+    isEnumValue(value, values) {
+        return typeof value === 'string' && values.includes(value);
+    }
+    resolveOptions(options) {
+        const mode = options.mode ?? 'roles_only';
+        if (!this.isEnumValue(mode, AWS_IAM_PLUGIN_MODES)) {
+            throw new Error(`${this.name} options.mode must be one of: ${AWS_IAM_PLUGIN_MODES.join(', ')}`);
+        }
+        const attachments = options.attachments ?? (mode === 'full' ? 'keep' : 'remove');
+        if (!this.isEnumValue(attachments, AWS_IAM_ATTACHMENT_MODES)) {
+            throw new Error(`${this.name} options.attachments must be one of: ${AWS_IAM_ATTACHMENT_MODES.join(', ')}`);
+        }
+        const policyDocuments = options.policyDocuments ?? (mode === 'full' ? 'all' : 'none');
+        if (!this.isEnumValue(policyDocuments, AWS_IAM_POLICY_DOCUMENT_MODES)) {
+            throw new Error(`${this.name} options.policyDocuments must be one of: ${AWS_IAM_POLICY_DOCUMENT_MODES.join(', ')}`);
+        }
+        const removeOrphans = options.removeOrphans ?? false;
+        if (typeof removeOrphans !== 'boolean') {
+            throw new Error(`${this.name} options.removeOrphans must be a boolean`);
+        }
+        return {
+            mode,
+            attachments,
+            policyDocuments,
+            removeOrphans,
+        };
+    }
+    buildKeepResourcesForMode(options) {
+        const keep = new Set(IAM_ROLE_RESOURCES);
+        if (options.mode === 'roles_policies') {
+            for (const resource of IAM_POLICY_RESOURCES) {
+                keep.add(resource);
+            }
+        }
+        if (options.attachments === 'keep') {
+            for (const resource of IAM_ATTACHMENT_RESOURCES) {
+                keep.add(resource);
+            }
+        }
+        if (options.policyDocuments !== 'none') {
+            keep.add(IAM_POLICY_DOCUMENT_RESOURCE);
+        }
+        return [...keep];
+    }
+    buildAttachmentPhases(options) {
+        if (options.attachments === 'keep') {
+            return [];
+        }
+        const phases = [];
+        if (options.attachments === 'convert_to_edge') {
+            phases.push([
+                new ConvertNodeToEdge({
+                    node: {
+                        attr: {
+                            key: 'terraform.resource',
+                            in: IAM_ATTACHMENT_RESOURCES,
+                        },
+                    },
+                }),
+            ]);
+        }
+        phases.push([
+            new RemoveNodeAndReconnectEdges({
+                node: {
+                    attr: {
+                        key: 'terraform.resource',
+                        in: IAM_ATTACHMENT_RESOURCES,
+                    },
+                },
+            }),
+        ]);
+        return phases;
+    }
+    buildIamDirectionPhases() {
+        return [
+            [
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamDataQuery(),
+                        to: this.iamResourceQuery('aws_iam_role_policy'),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamResourceQuery('aws_iam_role_policy'),
+                        to: this.iamResourceQuery('aws_iam_role_policy_attachment'),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamDataQuery(),
+                        to: this.iamResourceQuery('aws_iam_policy'),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamResourceQuery('aws_iam_policy'),
+                        to: this.iamResourceQuery('aws_iam_role_policy_attachment'),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamResourceQuery('aws_iam_policy'),
+                        to: this.iamResourceQuery('aws_iam_policy_attachment'),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamResourceQuery('aws_iam_role'),
+                        to: this.iamAttachmentQuery(),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamAttachmentQuery(),
+                        to: this.anyNonIamResourceQuery(),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamDataQuery(),
+                        to: this.iamResourceQuery('aws_iam_role'),
+                    },
+                }),
+                new EdgeReverse({
+                    edge: {
+                        from: this.iamResourceQuery('aws_iam_role'),
+                        to: this.anyNonIamResourceQuery(),
+                    },
+                }),
+            ],
+        ];
+    }
+    buildIamLabelHintPhases() {
+        return [
+            [
+                new NodeProperties({
+                    node: {
+                        and: [
+                            {
+                                attr: {
+                                    key: 'terraform.kind',
+                                    in: ['resource', 'data'],
+                                },
+                            },
+                            {
+                                attr: {
+                                    key: 'terraform.resource',
+                                    startsWith: 'aws_iam_',
+                                },
+                            },
+                            {
+                                attr: {
+                                    key: 'terraform.moduleAddress',
+                                    exists: true,
+                                },
+                            },
+                        ],
+                    },
+                    options: {
+                        hints: {
+                            label: {
+                                end: {
+                                    from: 'terraform.name',
+                                },
+                            },
+                        },
+                    },
+                }),
+            ],
+        ];
+    }
+    iamDataQuery() {
+        return {
+            and: [
+                {
+                    attr: {
+                        key: 'terraform.kind',
+                        eq: 'data',
+                    },
+                },
+                {
+                    attr: {
+                        key: 'terraform.resource',
+                        startsWith: 'aws_iam_',
+                    },
+                },
+            ],
+        };
+    }
+    iamResourceQuery(resource) {
+        return {
+            and: [
+                {
+                    attr: {
+                        key: 'terraform.kind',
+                        eq: 'resource',
+                    },
+                },
+                {
+                    attr: {
+                        key: 'terraform.resource',
+                        eq: resource,
+                    },
+                },
+            ],
+        };
+    }
+    iamAttachmentQuery() {
+        return {
+            and: [
+                {
+                    attr: {
+                        key: 'terraform.kind',
+                        eq: 'resource',
+                    },
+                },
+                {
+                    attr: {
+                        key: 'terraform.resource',
+                        in: IAM_ATTACHMENT_RESOURCES,
+                    },
+                },
+            ],
+        };
+    }
+    anyNonIamResourceQuery() {
+        return {
+            and: [
+                {
+                    attr: {
+                        key: 'terraform.kind',
+                        eq: 'resource',
+                    },
+                },
+                {
+                    not: {
+                        attr: {
+                            key: 'terraform.resource',
+                            startsWith: 'aws_iam_',
+                        },
+                    },
+                },
+            ],
+        };
+    }
+    orphanPrunableIamQuery() {
+        return {
+            or: [
+                {
+                    and: [
+                        {
+                            attr: {
+                                key: 'terraform.kind',
+                                eq: 'resource',
+                            },
+                        },
+                        {
+                            attr: {
+                                key: 'terraform.resource',
+                                in: IAM_ORPHAN_PRUNABLE_RESOURCES,
+                            },
+                        },
+                    ],
+                },
+                {
+                    and: [
+                        {
+                            attr: {
+                                key: 'terraform.kind',
+                                eq: 'data',
+                            },
+                        },
+                        {
+                            attr: {
+                                key: 'terraform.resource',
+                                in: IAM_ORPHAN_PRUNABLE_DATA_RESOURCES,
+                            },
+                        },
+                    ],
+                },
+            ],
+        };
+    }
+    buildCleanupPhases(options) {
+        const phases = [...this.toPhases('cleanup', this.buildIamDirectionPhases())];
+        if (!options.removeOrphans) {
+            return phases;
+        }
+        phases.push(...this.toPhases('cleanup', [
+            [
+                new RemoveLeafChain({
+                    node: this.orphanPrunableIamQuery(),
+                }),
+            ],
+        ]));
+        return phases;
+    }
+    buildPolicyDocumentPhases(options) {
+        if (options.policyDocuments === 'all') {
+            return [];
+        }
+        if (options.policyDocuments === 'none') {
+            return [
+                [
+                    new RemoveNodeAndReconnectEdges({
+                        node: {
+                            attr: {
+                                key: 'terraform.resource',
+                                eq: IAM_POLICY_DOCUMENT_RESOURCE,
+                            },
+                        },
+                    }),
+                ],
+            ];
+        }
+        return [
+            [
+                new RemoveNodeAndReconnectEdges({
+                    node: {
+                        and: [
+                            {
+                                attr: {
+                                    key: 'terraform.resource',
+                                    eq: IAM_POLICY_DOCUMENT_RESOURCE,
+                                },
+                            },
+                            {
+                                not: {
+                                    or: [
+                                        {
+                                            edge: {
+                                                in: {
+                                                    attr: {
+                                                        key: 'terraform.resource',
+                                                        eq: 'aws_iam_role',
+                                                    },
+                                                },
+                                            },
+                                        },
+                                        {
+                                            edge: {
+                                                out: {
+                                                    attr: {
+                                                        key: 'terraform.resource',
+                                                        eq: 'aws_iam_role',
+                                                    },
+                                                },
+                                            },
+                                        },
+                                    ],
+                                },
+                            },
+                        ],
+                    },
+                }),
+            ],
+        ];
+    }
+}

package/dist/esm/plugins/AwsIam.test.d.ts

@@ -0,0 +1 @@
+export {};