Kubernetes などの YAML を独自のルールをもとにテストする

main = rule {
  all tfplan.resources.aws_instance as _, instances {
    all instances as _, r {
      (length(r.applied.tags) else 0) > 0
    }
  }
}

rule "replicas" {
  description = "Check the number of replicas is sufficient"

  conditions = [
    "${jsonpath("spec.replicas") > 3}",
  ]

  report {
    level   = "ERROR"
    message = "Too few replicas"
  }
}

$ stein apply
manifests/microservices/x-echo-jp/development/Deployment/test.yaml
  [ERROR]  rule.replicas            Too few replicas

$ stein --help
Usage: stein [--version] [--help] <command> [<args>]

Available commands are:
    apply    Applies a policy to arbitrary config files.
    fmt      Formats a policy source to a canonical format.

$ stein apply -policy rule.hcl manifests/microservices/x-echo-jp/development/Deployment/test.yaml

$ export STEIN_POLICY=rule.hcl
$ stein apply manifests/microservices/x-echo-jp/development/Deployment/test.yaml

manifests/.policy/
manifests/microservices/.policy/
manifests/microservices/x-echo-jp/.policy/
manifests/microservices/x-echo-jp/development/.policy/
manifests/microservices/x-echo-jp/development/Deployment/.policy/

rule "namespace_name_irregular" {
  description = "Check namespace name is valid"

  // (省略できる)
  // このルールが依存するルールを書くことができる
  // この場合、rule.namespace_specification が失敗した場合このルールは apply されない
  depends_on = ["rule.namespace_specification"]

  // (省略できる)
  // このルールを apply するにあたって満たすべき評価式を指定できる
  // cases をすべて満たすとき、このルールが apply される
  precondition {
    cases = [
      "${is_irregular_namespace_pattern()}",
    ]
  }

  // (必須)
  // apply したときにこのルールを成功させるか失敗させるかを決める
  // ひとつでも false が返ったとき、このルールは失敗する
  conditions = [
    "${contains(lookuplist(var.namespace_name_map, jsonpath("metadata.namespace")), get_service_id_with_env(filename))}",
  ]

  // (必須)
  // ルールが失敗したときのレポートフォーマットを指定できる
  // ERROR の場合、stein の終了値は 1 になり、WARN のときはエラー表示はされるが終了値は 0 になる
  report {
    level   = "ERROR"
    message = "${format("This case is irregular pattern, so %q is invalid", jsonpath("metadata.namespace"))}"
  }
}

// Terraform の変数定義と同じ
variable "namespace_name_map" {
  type = "map"

  default = {
    "gateway" = [
      "x-gateway-jp-dev",
      "x-gateway-jp-prod",
    ]
  }
}

// ユーザ定義関数を定義できる
function "get_service_name" {
  params = [file]
  result = basename(dirname(dirname(dirname(file))))
}

function "get_env" {
  params = [file]
  result = basename(dirname(dirname(file)))
}

function "get_service_id_with_env" {
  params = [file]
  result = format("%s-%s", get_service_name(file), lookup(var.shortened_environment, get_env(file)))
}

$ tree -a _examples
_examples
├── .policy/
│   ├── config.hcl
│   ├── functions.hcl
│   ├── rules.hcl
│   └── variables.hcl
├── manifests/
│   ├── .policy/
│   │   ├── functions.hcl
│   │   └── rules.hcl
│   └── microservices/
│       ├── x-echo-jp/
│       │   └── development/
│       │       ├── Deployment/
│       │       │   ├── redis-master.yaml
│       │       │   ├── test.yaml
│       │       │   └── test.yml
│       │       ├── PodDisruptionBudget/
│       │       │   └── pdb.yaml
│       │       └── Service/
│       │           └── service.yaml
│       └── x-gateway-jp/
│           └── development/
│               └── Deployment/
│                   └── test.yaml
└── spinnaker/
    ├── .policy/
    │   └── functions.hcl
    └── x-echo-jp/
        └── development/
            └── deploy-to-dev-v2.yaml

# _examples にある例をもとに stein を実行する
$ make run