All files / handlers/rulegroups GetRuleGroupHandler.ts

100% Statements 16/16
100% Branches 10/10
100% Functions 2/2
100% Lines 14/14

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87                                    1x 1x 1x   1x                                                                     1x         1x   1x               4x 4x 2x         2x   2x 2x 2x      
/* 
  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  
  Licensed under the Apache License, Version 2.0 (the "License").
  You may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
      http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/
 
import { APIGatewayProxyEvent, Context } from 'aws-lambda';
import { Logger, LoggerFactory } from 'shared_types';
import RuleConfigError from 'src/common/RuleConfigError';
import { RuleGroupDataSourceService } from 'src/service/RuleGroupDataSourceService';
import { inject, injectable } from 'tsyringe';
import { AsyncRequestHandler } from 'src/common/AsyncRequestHandler';
import { ServerlessResponse } from 'src/common/ServerlessResponse';
 
 
export type ConfigurationEvaluationTriggerEvent = {
    ruleGroupId: string,
}
 
/**
 * @api {get} /rulegroups Get a rule group
 * @apiGroup RuleGroup
 * @apiDescription Get get rule group 
 * @apiVersion 1.0.0
 *  @apiExample {curl} CURL Example:
 curl --location --request GET 'https://<rest_api_id>.execute-api.ap-southeast-2.amazonaws.com/prod/rulegroups/{id}'
* @apiSuccess (Success 201) Rule Group created
* @apiError (Error 403) Forbidden Requestor's arn is not authorized to perform this action
* @apiError (Error 404) NotFound The rule group with {id} does not exits
* @apiError (Error 400) BadRequest ruleGroupArn does not exists
* @apiError (Error 502) Timeout
* @apiError (Error 503) ServiceUnavailable
* 
* @apiSuccessExample Success-Response: 
*  HTTP/1.1 200 OK
*  {
    "id":"demo-group-demo",
    "description": "demo rule group",
    "ownerGroup": [
        "arn:aws:iam::<account-number>:role/ObjectExtensionSecOpsAdminRole"
    ],
    "ruleGroupArn": "arn:aws:network-firewall:ap-southeast-2:<account-number>:stateful-rulegroup/anfwconfig-demo-rulegroup-1"
}
* 
* @apiSampleRequest off
*/
@injectable()
export class GetRuleConfigHandler
    implements AsyncRequestHandler<APIGatewayProxyEvent, ServerlessResponse> {
    private readonly logger: Logger;
 
    constructor(@inject('LoggerFactory') loggerFactory: LoggerFactory,
        @inject('RuleGroupDataSourceService') private ruleGroupDataSourceService: RuleGroupDataSourceService,
    ) {
        this.logger = loggerFactory.getLogger('RuleConfigHandler');
    }
 
    async handle(
        event: APIGatewayProxyEvent,
        // eslint-disable-next-line @typescript-eslint/no-unused-vars
        _context: Context
    ): Promise<ServerlessResponse> {
        this.logger.info('lambda event', event);
        if (!event.pathParameters || !event.pathParameters['id']) {
            return ServerlessResponse.ofError(
                new RuleConfigError('Parameter rule group id not found', 400, false)
            );
        }
 
        const ruleGroupId = event.pathParameters['id'];
 
        const ruleGroup = await this.ruleGroupDataSourceService.getRuleGroupBy(ruleGroupId);
        const returnCode = ruleGroup ? 200 : 404;
        return ServerlessResponse.ofObject(returnCode, ruleGroup ?? {});
    }
}