cost/aws/unused_albs/aws_unused_albs.pt

name "AWS Unused Application Load Balancers"
rs_pt_ver 20180301
type "policy"
short_description "Checks AWS for unused Application Load Balancers and, optionally, deletes them. See the [README](https://github.com/flexera-public/policy_templates/tree/master/cost/aws/unused_albs) and [docs.flexera.com/flexera/EN/Automation](https://docs.flexera.com/flexera/EN/Automation/AutomationGS.htm) to learn more."
long_description ""
category "Cost"
severity "low"
default_frequency "weekly"
info(
  version: "0.2.3",
  provider: "AWS",
  service: "Network",
  policy_set: "Unused Load Balancers",
  recommendation_type: "Usage Reduction",
  hide_skip_approvals: "true"
)

###############################################################################
# Parameters
###############################################################################

parameter "param_email" do
  type "list"
  category "Policy Settings"
  label "Email Addresses"
  description "A list of email addresses to notify."
  default []
end

parameter "param_aws_account_number" do
  type "string"
  category "Policy Settings"
  label "Account Number"
  description "Leave blank; this is for automated use with Meta Policies. See README for more details."
  default ""
end

parameter "param_min_savings" do
  type "number"
  category "Policy Settings"
  label "Minimum Savings Threshold"
  description "Minimum potential savings required to generate a recommendation"
  min_value 0
  default 0
end

parameter "param_loadbalancer_age" do
  type "number"
  category "Filters"
  label "Load Balancer Age (Hours)"
  description "Age, in hours, that an Application Load Balancer needs to be to include it in the results. This is to avoid reporting on very new Application Load Balancers that are still being configured."
  min_value 0
  default 1
end

parameter "param_regions_allow_or_deny" do
  type "string"
  category "Filters"
  label "Allow/Deny Regions"
  description "Allow or Deny entered regions. See the README for more details."
  allowed_values "Allow", "Deny"
  default "Allow"
end

parameter "param_regions_list" do
  type "list"
  category "Filters"
  label "Allow/Deny Regions List"
  description "A list of allowed or denied regions. See the README for more details."
  allowed_pattern /^([a-zA-Z-_]+-[a-zA-Z0-9-_]+-[0-9-_]+,*|)+$/
  default []
end

parameter "param_exclusion_tags" do
  type "list"
  category "Filters"
  label "Exclusion Tags"
  description "Cloud native tags to ignore resources that you don't want to produce recommendations for. Enter the Key name to filter resources with a specific Key, regardless of Value, and enter Key==Value to filter resources with a specific Key:Value pair. Other operators and regex are supported; please see the README for more details."
  default []
end

parameter "param_exclusion_tags_boolean" do
  type "string"
  category "Filters"
  label "Exclusion Tags: Any / All"
  description "Whether to filter instances containing any of the specified tags or only those that contain all of them. Only applicable if more than one value is entered in the 'Exclusion Tags' field."
  allowed_values "Any", "All"
  default "Any"
end

parameter "param_automatic_action" do
  type "list"
  category "Actions"
  label "Automatic Actions"
  description "When this value is set, this policy will automatically take the selected action(s)"
  allowed_values ["Delete Unused Application Load Balancers"]
  default []
end

###############################################################################
# Authentication
###############################################################################

credentials "auth_aws" do
  schemes "aws", "aws_sts"
  label "AWS"
  description "Select the AWS Credential from the list"
  tags "provider=aws"
  aws_account_number $param_aws_account_number
end

credentials "auth_flexera" do
  schemes "oauth2"
  label "Flexera"
  description "Select Flexera One OAuth2 credentials"
  tags "provider=flexera"
end

###############################################################################
# Datasources & Scripts
###############################################################################

# Get applied policy metadata for use later
datasource "ds_applied_policy" do
  request do
    auth $auth_flexera
    host rs_governance_host
    path join(["/api/governance/projects/", rs_project_id, "/applied_policies/", policy_id])
    header "Api-Version", "1.0"
  end
end

# Get region-specific Flexera API endpoints
datasource "ds_flexera_api_hosts" do
  run_script $js_flexera_api_hosts, rs_optima_host
end

script "js_flexera_api_hosts", type: "javascript" do
  parameters "rs_optima_host"
  result "result"
  code <<-'EOS'
  host_table = {
    "api.optima.flexeraeng.com": {
      flexera: "api.flexera.com",
      fsm: "api.fsm.flexeraeng.com"
    },
    "api.optima-eu.flexeraeng.com": {
      flexera: "api.flexera.eu",
      fsm: "api.fsm-eu.flexeraeng.com"
    },
    "api.optima-apac.flexeraeng.com": {
      flexera: "api.flexera.au",
      fsm: "api.fsm-apac.flexeraeng.com"
    }
  }

  result = host_table[rs_optima_host]
EOS
end

# Get AWS account info
datasource "ds_cloud_vendor_accounts" do
  request do
    auth $auth_flexera
    host val($ds_flexera_api_hosts, 'flexera')
    path join(["/finops-analytics/v1/orgs/", rs_org_id, "/cloud-vendor-accounts"])
    header "Api-Version", "1.0"
  end
  result do
    encoding "json"
    collect jmes_path(response, "values[*]") do
      field "id", jmes_path(col_item, "aws.accountId")
      field "name", jmes_path(col_item, "name")
      field "tags", jmes_path(col_item, "tags")
    end
  end
end

datasource "ds_get_caller_identity" do
  request do
    auth $auth_aws
    host "sts.amazonaws.com"
    path "/"
    query "Action", "GetCallerIdentity"
    query "Version", "2011-06-15"
    header "User-Agent", "RS Policies"
  end
  result do
    encoding "xml"
    collect xpath(response, "//GetCallerIdentityResponse/GetCallerIdentityResult") do
      field "account", xpath(col_item, "Account")
    end
  end
end

datasource "ds_aws_account" do
  run_script $js_aws_account, $ds_cloud_vendor_accounts, $ds_get_caller_identity
end

script "js_aws_account", type:"javascript" do
  parameters "ds_cloud_vendor_accounts", "ds_get_caller_identity"
  result "result"
  code <<-'EOS'
  result = _.find(ds_cloud_vendor_accounts, function(account) {
    return account['id'] == ds_get_caller_identity[0]['account']
  })

  // This is in case the API does not return the relevant account info
  if (result == undefined) {
    result = {
      id: ds_get_caller_identity[0]['account'],
      name: "",
      tags: {}
    }
  }
EOS
end

datasource "ds_billing_centers" do
  request do
    auth $auth_flexera
    host rs_optima_host
    path join(["/analytics/orgs/", rs_org_id, "/billing_centers"])
    query "view", "allocation_table"
    header "Api-Version", "1.0"
    header "User-Agent", "RS Policies"
    ignore_status [403]
  end
  result do
    encoding "json"
    collect jmes_path(response, "[*]") do
      field "href", jmes_path(col_item, "href")
      field "id", jmes_path(col_item, "id")
      field "name", jmes_path(col_item, "name")
      field "parent_id", jmes_path(col_item, "parent_id")
    end
  end
end

# Gather top level billing center IDs for when we pull cost data
datasource "ds_top_level_bcs" do
  run_script $js_top_level_bcs, $ds_billing_centers
end

script "js_top_level_bcs", type: "javascript" do
  parameters "ds_billing_centers"
  result "result"
  code <<-'EOS'
  filtered_bcs = _.filter(ds_billing_centers, function(bc) {
    return bc['parent_id'] == null || bc['parent_id'] == undefined
  })

  result = _.compact(_.pluck(filtered_bcs, 'id'))
EOS
end

datasource "ds_currency_reference" do
  request do
    host "raw.githubusercontent.com"
    path "/flexera-public/policy_templates/master/data/currency/currency_reference.json"
    header "User-Agent", "RS Policies"
  end
end

datasource "ds_currency_code" do
  request do
    auth $auth_flexera
    host rs_optima_host
    path join(["/bill-analysis/orgs/", rs_org_id, "/settings/currency_code"])
    header "Api-Version", "0.1"
    header "User-Agent", "RS Policies"
    ignore_status [403]
  end
  result do
    encoding "json"
    field "id", jmes_path(response, "id")
    field "value", jmes_path(response, "value")
  end
end

datasource "ds_currency" do
  run_script $js_currency, $ds_currency_reference, $ds_currency_code
end

script "js_currency", type:"javascript" do
  parameters "ds_currency_reference", "ds_currency_code"
  result "result"
  code <<-'EOS'
  symbol = "$"
  separator = ","

  if (ds_currency_code['value'] != undefined) {
    if (ds_currency_reference[ds_currency_code['value']] != undefined) {
      symbol = ds_currency_reference[ds_currency_code['value']]['symbol']

      if (ds_currency_reference[ds_currency_code['value']]['t_separator'] != undefined) {
        separator = ds_currency_reference[ds_currency_code['value']]['t_separator']
      } else {
        separator = ""
      }
    }
  }

  result = {
    symbol: symbol,
    separator: separator
  }
EOS
end

datasource "ds_describe_regions" do
  request do
    auth $auth_aws
    host "ec2.amazonaws.com"
    path "/"
    query "Action", "DescribeRegions"
    query "Version", "2016-11-15"
    query "Filter.1.Name", "opt-in-status"
    query "Filter.1.Value.1", "opt-in-not-required"
    query "Filter.1.Value.2", "opted-in"
    # Header X-Meta-Flexera has no affect on datasource query, but is required for Meta Policies
    # Forces `ds_is_deleted` datasource to run first during policy execution
    header "Meta-Flexera", val($ds_is_deleted, "path")
  end
  result do
    encoding "xml"
    collect xpath(response, "//DescribeRegionsResponse/regionInfo/item", "array") do
      field "region", xpath(col_item, "regionName")
    end
  end
end

datasource "ds_regions" do
  run_script $js_regions, $ds_describe_regions, $param_regions_list, $param_regions_allow_or_deny
end

script "js_regions", type:"javascript" do
  parameters "ds_describe_regions", "param_regions_list", "param_regions_allow_or_deny"
  result "result"
  code <<-'EOS'
  allow_deny_test = { "Allow": true, "Deny": false }

  if (param_regions_list.length > 0) {
    result = _.filter(ds_describe_regions, function(item) {
      return _.contains(param_regions_list, item['region']) == allow_deny_test[param_regions_allow_or_deny]
    })
  } else {
    result = ds_describe_regions
  }
EOS
end

datasource "ds_elbs_without_tags" do
  iterate $ds_regions
  request do
    auth $auth_aws
    host join(["elasticloadbalancing.", val(iter_item, "region"), ".amazonaws.com"])
    path "/"
    query "Action", "DescribeLoadBalancers"
    query "Version", "2015-12-01"
    header "Accept", "application/json"
  end
  result do
    encoding "json"
    collect jmes_path(response, "DescribeLoadBalancersResponse.DescribeLoadBalancersResult.LoadBalancers[*]") do
      field "name", jmes_path(col_item, "LoadBalancerName")
      field "scheme", jmes_path(col_item, "Scheme")
      field "created", jmes_path(col_item, "CreatedTime")
      field "dns", jmes_path(col_item, "DNSName")
      field "vpc", jmes_path(col_item, "VpcId")
      field "elb_zones" do
        collect jmes_path(col_item, "AvailabilityZones") do
          field "subnetId", jmes_path(col_item, "SubnetId")
          field "zoneName", jmes_path(col_item, "ZoneName")
        end
      end
      field "type", jmes_path(col_item, "Type")
      field "arn", jmes_path(col_item, "LoadBalancerArn")
      field "region", val(iter_item, "region")
    end
  end
end

datasource "ds_albs_without_tags" do
  run_script $js_albs_without_tags, $ds_elbs_without_tags
end

script "js_albs_without_tags", type: "javascript" do
  parameters "ds_elbs_without_tags"
  result "result"
  code <<-'EOS'
  result = _.filter(ds_elbs_without_tags, function(lb) { return lb['type'].toLowerCase() == 'application' })
EOS
end

datasource "ds_albs" do
  iterate $ds_albs_without_tags
  request do
    run_script $js_albs, val(iter_item, 'region'), val(iter_item, 'arn')
  end
  result do
    encoding "json"
    collect jmes_path(response, "DescribeTagsResponse.DescribeTagsResult.TagDescriptions[*]") do
      field "tags" do
        collect jmes_path(col_item, "Tags") do
          field "key", jmes_path(col_item, "Key")
          field "value", jmes_path(col_item, "Value")
        end
      end
      field "name", val(iter_item, "name")
      field "scheme", val(iter_item, "scheme")
      field "created", val(iter_item, "created")
      field "dns", val(iter_item, "dns")
      field "vpc", val(iter_item, "vpc")
      field "zones", val(iter_item, "elb_zones")
      field "region", val(iter_item, "region")
      field "type", val(iter_item, "type")
      field "arn", val(iter_item, "arn")
    end
  end
end

script "js_albs", type: "javascript" do
  parameters "region", "arn"
  result "request"
  code <<-EOS
  var request = {
    auth: "auth_aws",
    host: "elasticloadbalancing." + region + ".amazonaws.com",
    path: "/",
    query_params: {
      "Action": "DescribeTags",
      "Version": "2015-12-01",
      "ResourceArns.member.1": encodeURI(arn)
    },
    headers: { "Accept": "application/json" }
  }
EOS
end

datasource "ds_albs_age_filtered" do
  run_script $js_albs_age_filtered, $ds_albs, $param_loadbalancer_age
end

script "js_albs_age_filtered", type: "javascript" do
  parameters "ds_albs", "param_loadbalancer_age"
  result "result"
  code <<-'EOS'
  now = new Date()

  if (param_loadbalancer_age > 0) {
    result = _.filter(ds_albs, function(lb) {
      hours = param_loadbalancer_age * 3600000
      created = new Date(Math.round(lb['created'] * 1000))
      return now - created > hours
    })
  } else {
    result = ds_albs
  }
EOS
end

datasource "ds_albs_tag_filtered" do
  run_script $js_albs_tag_filtered, $ds_albs_age_filtered, $param_exclusion_tags, $param_exclusion_tags_boolean
end

script "js_albs_tag_filtered", type: "javascript" do
  parameters "ds_albs_age_filtered", "param_exclusion_tags", "param_exclusion_tags_boolean"
  result "result"
  code <<-'EOS'
  comparators = _.map(param_exclusion_tags, function(item) {
    if (item.indexOf('==') != -1) {
      return { comparison: '==', key: item.split('==')[0], value: item.split('==')[1], string: item }
    }

    if (item.indexOf('!=') != -1) {
      return { comparison: '!=', key: item.split('!=')[0], value: item.split('!=')[1], string: item }
    }

    if (item.indexOf('=~') != -1) {
      value = item.split('=~')[1]
      regex = new RegExp(value.slice(1, value.length - 1))
      return { comparison: '=~', key: item.split('=~')[0], value: regex, string: item }
    }

    if (item.indexOf('!~') != -1) {
      value = item.split('!~')[1]
      regex = new RegExp(value.slice(1, value.length - 1))
      return { comparison: '!~', key: item.split('!~')[0], value: regex, string: item }
    }

    // If = is present but none of the above are, assume user error and that the user intended ==
    if (item.indexOf('=') != -1) {
      return { comparison: '==', key: item.split('=')[0], value: item.split('=')[1], string: item }
    }

    // Assume we're just testing for a key if none of the comparators are found
    return { comparison: 'key', key: item, value: null, string: item }
  })

  if (param_exclusion_tags.length > 0) {
    result = _.reject(ds_albs_age_filtered, function(resource) {
      resource_tags = {}

      if (typeof(resource['tags']) == 'object') {
        _.each(resource['tags'], function(tag) {
          resource_tags[tag['key']] = tag['value']
        })
      }

      // Store a list of found tags
      found_tags = []

      _.each(comparators, function(comparator) {
        comparison = comparator['comparison']
        value = comparator['value']
        string = comparator['string']
        resource_tag = resource_tags[comparator['key']]

        if (comparison == 'key' && resource_tag != undefined) { found_tags.push(string) }
        if (comparison == '==' && resource_tag == value) { found_tags.push(string) }
        if (comparison == '!=' && resource_tag != value) { found_tags.push(string) }

        if (comparison == '=~') {
          if (resource_tag != undefined && value.test(resource_tag)) { found_tags.push(string) }
        }

        if (comparison == '!~') {
          if (resource_tag == undefined) { found_tags.push(string) }
          if (resource_tag != undefined && value.test(resource_tag)) { found_tags.push(string) }
        }
      })

      all_tags_found = found_tags.length == comparators.length
      any_tags_found = found_tags.length > 0 && param_exclusion_tags_boolean == 'Any'

      return all_tags_found || any_tags_found
    })
  } else {
    result = ds_albs_age_filtered
  }
EOS
end

datasource "ds_alb_listeners" do
  iterate $ds_albs_tag_filtered
  request do
    auth $auth_aws
    host join(["elasticloadbalancing.", val(iter_item, "region"), ".amazonaws.com"])
    path "/"
    query "Action", "DescribeListeners"
    query "Version", "2015-12-01"
    query "LoadBalancerArn", val(iter_item, "arn")
    header "Accept", "application/json"
  end
  result do
    encoding "json"
    collect jmes_path(response, "DescribeListenersResponse.DescribeListenersResult.Listeners[*]") do
      field "protocol", jmes_path(col_item, "Protocol")
      field "port", jmes_path(col_item, "Port")
      field "arn", val(iter_item, "arn")
    end
  end
end

datasource "ds_alb_target_groups" do
  iterate $ds_albs_tag_filtered
  request do
    auth $auth_aws
    host join(["elasticloadbalancing.", val(iter_item, "region"), ".amazonaws.com"])
    path "/"
    query "Action", "DescribeTargetGroups"
    query "Version", "2015-12-01"
    query "LoadBalancerArn", val(iter_item, "arn")
    header "Accept", "application/json"
  end
  result do
    encoding "json"
    collect jmes_path(response, "DescribeTargetGroupsResponse.DescribeTargetGroupsResult.TargetGroups[*]") do
      field "targetGroupArn", jmes_path(col_item, "TargetGroupArn")
      field "targetGroupName", jmes_path(col_item, "TargetGroupName")
      field "healthCheckTimeoutSeconds", jmes_path(col_item, "HealthCheckTimeoutSeconds")
      field "healthCheckPort", jmes_path(col_item, "HealthCheckPort")
      field "healthCheckProtocol", jmes_path(col_item, "HealthCheckProtocol")
      field "healthCheckPath", jmes_path(col_item, "HealthCheckPath")
      field "healthCheckIntervalSeconds", jmes_path(col_item, "HealthCheckIntervalSeconds")
      field "healthyThresholdCount", jmes_path(col_item, "HealthyThresholdCount")
      field "unhealthyThresholdCount", jmes_path(col_item, "UnhealthyThresholdCount")
      field "matcher", jmes_path(col_item, "Matcher")
      field "protocol", jmes_path(col_item, "Protocol")
      field "port", jmes_path(col_item, "Port")
      field "vpcId", jmes_path(col_item, "VpcId")
      field "arn", val(iter_item, "arn")
      field "region", val(iter_item, "region")
    end
  end
end

datasource "ds_alb_target_groups_health" do
  iterate $ds_alb_target_groups
  request do
    run_script $js_alb_target_groups_health, val(iter_item, 'region'), val(iter_item, 'targetGroupArn')
  end
  result do
    encoding "json"
    collect jmes_path(response, "DescribeTargetHealthResponse.DescribeTargetHealthResult.TargetHealthDescriptions[*]") do
      field "targetHealth", jmes_path(col_item, "TargetHealth.State")
      field "targetGroupArn", val(iter_item, "targetGroupArn")
      field "arn", val(iter_item, "arn")
      field "region", val(iter_item, "region")
    end
  end
end

script "js_alb_target_groups_health", type: "javascript" do
  parameters "region", "targetGroupArn"
  result "request"
  code <<-EOS
  var request = {
    auth: "auth_aws",
    host: "elasticloadbalancing." + region + ".amazonaws.com",
    path: "/",
    query_params: {
      "Action": "DescribeTargetHealth",
      "Version": "2015-12-01",
      "TargetGroupArn": encodeURI(targetGroupArn)
    },
    headers: { "Accept": "application/json" }
  }
EOS
end

datasource "ds_albs_combined" do
  run_script $js_albs_combined, $ds_albs_tag_filtered, $ds_alb_listeners, $ds_alb_target_groups, $ds_alb_target_groups_health
end

script "js_albs_combined", type: "javascript" do
  parameters "ds_albs_tag_filtered", "ds_alb_listeners", "ds_alb_target_groups", "ds_alb_target_groups_health"
  result "result"
  code <<-'EOS'
  listener_table = _.groupBy(ds_alb_listeners, 'arn')
  group_table = _.groupBy(ds_alb_target_groups, 'arn')
  health_table = _.groupBy(ds_alb_target_groups_health, 'targetGroupArn')

  result = _.map(ds_albs_tag_filtered, function(lb) {
    listeners = []
    if (listener_table[lb['arn']] != undefined) { listeners = listener_table[lb['arn']] }

    target_groups_without_health = []
    if (group_table[lb['arn']] != undefined) { target_groups_without_health = group_table[lb['arn']] }

    target_groups = _.map(target_groups_without_health, function(group) {
      healthStatus = "unknown"

      if (health_table[group['targetGroupArn']] != undefined) {
        healthStatus = health_table[group['targetGroupArn']][0]['targetHealth']
      }

      return {
        targetGroupArn: group['targetGroupArn'],
        targetGroupName: group['targetGroupName'],
        healthCheckTimeoutSeconds: group['healthCheckTimeoutSeconds'],
        healthCheckPort: group['healthCheckPort'],
        healthCheckProtocol: group['healthCheckProtocol'],
        healthCheckPath: group['healthCheckPath'],
        healthCheckIntervalSeconds: group['healthCheckIntervalSeconds'],
        healthyThresholdCount: group['healthyThresholdCount'],
        unhealthyThresholdCount: group['unhealthyThresholdCount'],
        matcher: group['matcher'],
        protocol: group['protocol'],
        port: group['port'],
        vpcId: group['vpcId'],
        healthStatus: healthStatus
      }
    })

    healthy_groups = _.filter(target_groups, function(group) { return group['healthStatus'] == 'healthy' })

    tags = []

    if (typeof(lb['tags']) == 'object') {
      tags = _.map(lb['tags'], function(tag) { return tag['key'] + '=' + tag['value'] })
    }

    created = new Date(Math.round(lb['created'] * 1000)).toISOString()

    zones = []

    if (typeof(lb['zones']) == 'object') {
      zones = _.map(lb['zones'], function(zone) { return 'subnet:' + zone['subnetId'] + ' ' + 'zone:' + zone['zoneName'] })
    }

    return {
      name: lb['name'],
      scheme: lb['scheme'],
      dns: lb['dns'],
      vpc: lb['vpc'],
      region: lb['region'],
      type: lb['type'],
      arn: lb['arn'],
      zones: zones.join(', '),
      tags: tags.join(', '),
      created: created,
      listeners: listeners,
      target_groups: target_groups,
      healthy_groups: healthy_groups
    }
  })
EOS
end

datasource "ds_alb_costs" do
  request do
    run_script $js_alb_costs, $ds_aws_account, $ds_top_level_bcs, rs_org_id, rs_optima_host
  end
  result do
    encoding "json"
    collect jmes_path(response, "rows[*]") do
      field "id", jmes_path(col_item, "dimensions.resource_id")
      field "cost", jmes_path(col_item, "metrics.cost_amortized_blended_adj")
    end
  end
end

script "js_alb_costs", type:"javascript" do
  parameters "ds_aws_account", "ds_top_level_bcs", "rs_org_id", "rs_optima_host"
  result "request"
  code <<-'EOS'
  start_date = new Date()
  start_date.setDate(start_date.getDate() - 3)
  start_date = start_date.toISOString().split('T')[0]

  end_date = new Date()
  end_date.setDate(end_date.getDate() - 2)
  end_date = end_date.toISOString().split('T')[0]

  var request = {
    auth: "auth_flexera",
    host: rs_optima_host,
    verb: "POST",
    path: "/bill-analysis/orgs/" + rs_org_id + "/costs/select",
    body_fields: {
      "dimensions": ["resource_id"],
      "granularity": "day",
      "start_at": start_date,
      "end_at": end_date,
      "metrics": ["cost_amortized_blended_adj"],
      "billing_center_ids": ds_top_level_bcs,
      "limit": 100000,
      "filter": {
        "type": "and",
        "expressions": [
          {
            "dimension": "service",
            "type": "equal",
            "value": "AWSELB"
          },
          {
            "dimension": "resource_type",
            "type": "equal",
            "value": "Load Balancer-Application"
          },
          {
            "dimension": "vendor_account",
            "type": "equal",
            "value": ds_aws_account['id']
          }
        ]
      }
    },
    headers: {
      "User-Agent": "RS Policies",
      "Api-Version": "1.0"
    },
    ignore_status: [400]
  }
EOS
end

datasource "ds_alb_costs_grouped" do
  run_script $js_alb_costs_grouped, $ds_alb_costs
end

script "js_alb_costs_grouped", type: "javascript" do
  parameters "ds_alb_costs"
  result "result"
  code <<-'EOS'
  // Multiple a single day's cost by the average number of days in a month.
  // The 0.25 is to account for leap years for extra precision.
  cost_multiplier = 365.25 / 12

  // Group cost data by resourceId for later use
  result = {}

  _.each(ds_alb_costs, function(item) {
    id = item['id'].toLowerCase()

    if (result[id] == undefined) { result[id] = 0.0 }
    result[id] += item['cost'] * cost_multiplier
  })
EOS
end

datasource "ds_bad_albs" do
  run_script $js_bad_albs, $ds_albs_combined, $ds_alb_costs_grouped, $ds_aws_account, $ds_currency, $ds_applied_policy, $param_loadbalancer_age, $param_min_savings
end

script "js_bad_albs", type: "javascript" do
  parameters "ds_albs_combined", "ds_alb_costs_grouped", "ds_aws_account", "ds_currency", "ds_applied_policy", "param_loadbalancer_age", "param_min_savings"
  result "result"
  code <<-'EOS'
  // Used for formatting numbers to look pretty
  function formatNumber(number, separator) {
    formatted_number = "0"

    if (number) {
      formatted_number = (Math.round(number * 100) / 100).toString().split(".")[0]

      if (separator) {
        withSeparator = ""

        for (var i = 0; i < formatted_number.length; i++) {
          if (i > 0 && (formatted_number.length - i) % 3 == 0) { withSeparator += separator }
          withSeparator += formatted_number[i]
        }

        formatted_number = withSeparator
      }

      decimal = (Math.round(number * 100) / 100).toString().split(".")[1]
      if (decimal) { formatted_number += "." + decimal }
    }

    return formatted_number
  }

  result = []
  total_savings = 0.0

  _.each(ds_albs_combined, function(lb) {
    lb_id = lb['name'].toLowerCase()
    savings = 0.0
    if (ds_alb_costs_grouped[lb_id] != undefined) { savings = ds_alb_costs_grouped[lb_id] }

    if (savings >= param_min_savings && (lb['listeners'].length == 0 || lb['healthy_groups'].length == 0)) {
      total_savings += savings

      recommendationDetails = [
        "Delete AWS Application Load Balancer ", lb['name'], " ",
        "in AWS Account ", ds_aws_account['name'], " ",
        "(", ds_aws_account['id'], ")"
      ].join('')

      result.push({
        accountID: ds_aws_account['id'],
        accountName: ds_aws_account['name'],
        resourceName: lb['name'],
        resourceID: lb['arn'],
        resourceARN: lb['arn'],
        scheme: lb['scheme'],
        dns: lb['dns'],
        vpc: lb['vpc'],
        zones: lb['zones'],
        region: lb['region'],
        savings: Math.round(savings * 1000) / 1000,
        savingsCurrency: ds_currency['symbol'],
        policy_name: ds_applied_policy['name'],
        created: lb['created'],
        tags: lb['tags'],
        totalListeners: lb['listeners'].length,
        totalGroups: lb['target_groups'].length,
        totalHealthyGroups: lb['healthy_groups'].length,
        type: "Application Load Balancer",
        service: "ELB",
        recommendationDetails: recommendationDetails,
        // These are to avoid errors when we hash_exclude these fields
        message: "",
        total_savings: ""
      })
    }
  })

  // Message for incident output
  total_lbs = ds_albs_combined.length.toString()
  total_unused_lbs = result.length.toString()
  unused_lbs_percentage = (total_unused_lbs / total_lbs * 100).toFixed(2).toString() + '%'

  lb_noun = "Application Load Balancer"
  if (total_lbs > 1) { lb_noun += "s" }

  lb_verb = "is"
  if (total_unused_lbs > 1) { lb_verb = "are" }

  findings = [
    "Out of ", total_lbs, " AWS ", lb_noun, " analyzed, ",
    total_unused_lbs, " (", unused_lbs_percentage,
    ") ", lb_verb, " unused and recommended for deletion. ",
    "Application Load Balancers are considered unused if they either have ",
    "no listeners configured or have no target groups in a 'healthy' status ",
    "with at least one target. "
  ].join('')

  time_noun = "hours"
  if (param_loadbalancer_age == 1) {time_noun = "hour" }

  settings = "Results do not exclude recently created AWS Application Load Balancers.\n\n"

  if (param_loadbalancer_age != 0) {
    settings = [
      "AWS Application Load Balancers older than ", param_loadbalancer_age, " ", time_noun,
      " were excluded from the results.\n\n"
    ].join('')
  }

  disclaimer = "The above settings can be modified by editing the applied policy and changing the appropriate parameters."

  total_savings = ds_currency['symbol'] + ' ' + formatNumber(parseFloat(total_savings).toFixed(2), ds_currency['separator'])

  // Dummy item to ensure the policy's check statement always executes at least once
  result.push({
    resourceID: "",
    message: "",
    total_savings: "",
    tags: "",
    savings: "",
    savingsCurrency: ""
  })

  result[0]['message'] = findings + settings + disclaimer
  result[0]['total_savings'] = total_savings
EOS
end

###############################################################################
# Policy
###############################################################################

policy "pol_unused_albs" do
  validate_each $ds_bad_albs do
    summary_template "{{ with index data 0 }}{{ .policy_name }}{{ end }}: {{ len data }} AWS Unused Application Load Balancers Found"
    detail_template <<-'EOS'
    **Potential Monthly Savings:** {{ with index data 0 }}{{ .total_savings }}{{ end }}

    {{ with index data 0 }}{{ .message }}{{ end }}
    EOS
    check logic_or($ds_parent_policy_terminated, eq(val(item, "resourceID"), ""))
    escalate $esc_email
    escalate $esc_delete_albs
    hash_exclude "message", "total_savings", "tags", "savings", "savingsCurrency"
    export do
      resource_level true
      field "accountID" do
        label "Account ID"
      end
      field "accountName" do
        label "Account Name"
      end
      field "resourceName" do
        label "Resource Name"
      end
      field "resourceID" do
        label "Resource ARN"
      end
      field "dns" do
        label "DNS Name"
      end
      field "tags" do
        label "Resource Tags"
      end
      field "recommendationDetails" do
        label "Recommendation"
      end
      field "type" do
        label "Type"
      end
      field "region" do
        label "Region"
      end
      field "totalListeners" do
        label "Listeners (#)"
      end
      field "totalGroups" do
        label "Target Groups (#)"
      end
      field "totalHealthyGroups" do
        label "Healthy Target Groups (#)"
      end
      field "savings" do
        label "Estimated Monthly Savings"
      end
      field "savingsCurrency" do
        label "Savings Currency"
      end
      field "zones" do
        label "Availability Zones"
      end
      field "vpc" do
        label "VPC"
      end
      field "created" do
        label "Creation Date"
      end
      field "service" do
        label "Service"
      end
      field "resourceARN" do
        label "Resource ARN"
      end
      field "id" do
        label "ID"
        path "resourceID"
      end
    end
  end
end

###############################################################################
# Escalations
###############################################################################

escalation "esc_email" do
  automatic true
  label "Send Email"
  description "Send incident email"
  email $param_email
end

escalation "esc_delete_albs" do
  automatic contains($param_automatic_action, "Delete Unused Application Load Balancers")
  label "Delete Unused Application Load Balancers"
  description "Approval to delete all selected Application Load Balancers"
  run "delete_albs", data
end

###############################################################################
# Cloud Workflow
###############################################################################

define delete_albs($data) return $all_responses do
  $$all_responses = []

  foreach $alb in $data do
    sub on_error: handle_error() do
      call delete_alb($alb) retrieve $response
    end
  end

  if inspect($$errors) != "null"
    raise join($$errors, "\n")
  end
end

define delete_alb($alb) return $response do
  $host = "elasticloadbalancing." + $alb["region"] + ".amazonaws.com"
  $href = "/"
  $params = "?Action=DeleteLoadBalancer&Version=2015-12-01&LoadBalancerArn=" + $alb["resourceID"]
  $url = $host + $href + $params
  task_label("GET " + $url)

  $response = http_request(
    auth: $$auth_aws,
    https: true,
    verb: "get",
    host: $host,
    href: $href,
    query_strings: {
      "Action": "DeleteLoadBalancer",
      "Version": "2015-12-01",
      "LoadBalancerArn": $alb["resourceID"]
    }
  )

  task_label("GET AWS Application Load Balancer response: " + $alb["resourceID"] + " " + to_json($response))
  $$all_responses << to_json({"req": "GET " + $url, "resp": $response})

  if $response["code"] != 204 && $response["code"] != 202 && $response["code"] != 200
    raise "Unexpected response from GET AWS Application Load Balancer: "+ $alb["resourceID"] + " " + to_json($response)
  else
    task_label("GET AWS Application Load Balancer successful: " + $alb["resourceID"])
  end
end

define handle_error() do
  if !$$errors
    $$errors = []
  end
  $$errors << $_error["type"] + ": " + $_error["message"]
  # We check for errors at the end, and raise them all together
  # Skip errors handled by this definition
  $_error_behavior = "skip"
end

###############################################################################
# Meta Policy [alpha]
# Not intended to be modified or used by policy developers
###############################################################################

# If the meta_parent_policy_id is not set it will evaluate to an empty string and we will look for the policy itself,
# if it is set we will look for the parent policy.
datasource "ds_get_policy" do
  request do
    auth $auth_flexera
    host rs_governance_host
    ignore_status [404]
    path join(["/api/governance/projects/", rs_project_id, "/applied_policies/", switch(ne(meta_parent_policy_id, ""), meta_parent_policy_id, policy_id)])
    header "Api-Version", "1.0"
  end
  result do
    encoding "json"
    field "id", jmes_path(response, "id")
  end
end

datasource "ds_parent_policy_terminated" do
  run_script $js_decide_if_self_terminate, $ds_get_policy, policy_id, meta_parent_policy_id
end

# If the policy was applied by a meta_parent_policy we confirm it exists if it doesn't we confirm we are deleting
# This information is used in two places:
# - determining whether or not we make a delete call
# - determining if we should create an incident (we don't want to create an incident on the run where we terminate)
script "js_decide_if_self_terminate", type: "javascript" do
  parameters "found", "self_policy_id", "meta_parent_policy_id"
  result "result"
  code <<-EOS
  var result
  if (meta_parent_policy_id != "" && found.id == undefined) {
    result = true
  } else {
    result = false
  }
  EOS
end

# Two potentials ways to set this up:
# - this way and make a unneeded 'get' request when not deleting
# - make the delete request an interate and have it iterate over an empty array when not deleting and an array with one item when deleting
script "js_make_terminate_request", type: "javascript" do
  parameters "should_delete", "policy_id", "rs_project_id", "rs_governance_host"
  result "request"
  code <<-EOS

  var request = {
    auth:  'auth_flexera',
    host: rs_governance_host,
    path: "/api/governance/projects/" + rs_project_id + "/applied_policies/" + policy_id,
    headers: {
      "API-Version": "1.0",
      "Content-Type":"application/json"
    },
  }

  if (should_delete) {
    request.verb = 'DELETE'
  }
  EOS
end

datasource "ds_terminate_self" do
  request do
    run_script $js_make_terminate_request, $ds_parent_policy_terminated, policy_id, rs_project_id, rs_governance_host
  end
end

datasource "ds_is_deleted" do
  run_script $js_check_deleted, $ds_terminate_self
end

# This is just a way to have the check delete request connect to the farthest leaf from policy.
# We want the delete check to the first thing the policy does to avoid the policy erroring before it can decide whether or not it needs to self terminate
# Example a customer deletes a credential and then terminates the parent policy. We still want the children to self terminate
# The only way I could see this not happening is if the user who applied the parent_meta_policy was offboarded or lost policy access, the policies who are impersonating the user
# would not have access to self-terminate
# It may be useful for the backend to enable a mass terminate at some point for all meta_child_policies associated with an id.
script "js_check_deleted", type: "javascript" do
  parameters "response"
  result "result"
  code <<-EOS
  result = {"path":"/"}
  EOS
end