Installation and usage instructions

Author: DivineOmega

README.md

@@ -1,2 +1,87 @@
-# php-hcl-parser
-PHP HCL Parser
+# PHP HCL Parser
+
+HCL is a configuration language make by HashiCorp. HCL files are used by several HashiCorp products,
+including Terraform.
+
+This library parses HCL configuration files into PHP objects.
+
+## Installation
+
+You can install the PHP HCL Parser library using Composer. Just run the following command
+from the root of your project.
+
+```
+composer require divineomega/php-hcl-parser
+```
+
+## Usage
+
+To parse HCL into a PHP object, create a new `HCLParser` object passing a string of HCL configuration
+as the first parameter of the construction, then call the `parse` method. See the example below.
+
+```php
+$hcl = '
+# Specify the provider and access details
+provider "aws" {
+ access_key = "${var.access_key}"
+ secret_key = "${var.secret_key}"
+ region = "${var.region}"
+}
+
+# Create an instance
+resource "aws_instance" "example" {
+ ami = "ami-2757f631"
+ instance_type = "t2.micro"
+}
+
+';
+
+$configObject = (new HCLParser($hcl))->parse();
+```
+
+The resulting object will be returned in the following format.
+
+```php
+object(stdClass)#5 (2) {
+ ["provider"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#4 (1) {
+ ["aws"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#2 (3) {
+ ["access_key"]=>
+ string(17) "${var.access_key}"
+ ["region"]=>
+ string(13) "${var.region}"
+ ["secret_key"]=>
+ string(17) "${var.secret_key}"
+ }
+ }
+ }
+ }
+ ["resource"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#8 (1) {
+ ["aws_instance"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#7 (1) {
+ ["example"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#6 (2) {
+ ["ami"]=>
+ string(12) "ami-2757f631"
+ ["instance_type"]=>
+ string(8) "t2.micro"
+ }
+ }
+ }
+ }
+ }
+ }
+}
+```

test.php

@@ -7,148 +7,66 @@
 $hcl = '
 # Specify the provider and access details
 provider "aws" {
- region = "${var.aws_region}"
+ access_key = "${var.access_key}"
+ secret_key = "${var.secret_key}"
+ region = "${var.region}"
 }
 
-# Create a VPC to launch our instances into
-resource "aws_vpc" "default" {
- cidr_block = "10.0.0.0/16"
-}
-
-# Create an internet gateway to give our subnet access to the outside world
-resource "aws_internet_gateway" "default" {
- vpc_id = "${aws_vpc.default.id}"
-}
-
-# Grant the VPC internet access on its main route table
-resource "aws_route" "internet_access" {
- route_table_id = "${aws_vpc.default.main_route_table_id}"
- destination_cidr_block = "0.0.0.0/0"
- gateway_id = "${aws_internet_gateway.default.id}"
-}
-
-# Create a subnet to launch our instances into
-resource "aws_subnet" "default" {
- vpc_id = "${aws_vpc.default.id}"
- cidr_block = "10.0.1.0/24"
- map_public_ip_on_launch = true
-}
-
-# A security group for the ELB so it is accessible via the web
-resource "aws_security_group" "elb" {
- name = "terraform_example_elb"
- description = "Used in the terraform"
- vpc_id = "${aws_vpc.default.id}"
-
- # HTTP access from anywhere
- ingress {
- from_port = 80
- to_port = 80
- protocol = "tcp"
- cidr_blocks = ["0.0.0.0/0"]
- }
-
- # outbound internet access
- egress {
- from_port = 0
- to_port = 0
- protocol = "-1"
- cidr_blocks = ["0.0.0.0/0"]
- }
-}
-
-# Our default security group to access
-# the instances over SSH and HTTP
-resource "aws_security_group" "default" {
- name = "terraform_example"
- description = "Used in the terraform"
- vpc_id = "${aws_vpc.default.id}"
-
- # SSH access from anywhere
- ingress {
- from_port = 22
- to_port = 22
- protocol = "tcp"
- cidr_blocks = ["0.0.0.0/0"]
- }
-
- # HTTP access from the VPC
- ingress {
- from_port = 80
- to_port = 80
- protocol = "tcp"
- cidr_blocks = ["10.0.0.0/16"]
- }
-
- # outbound internet access
- egress {
- from_port = 0
- to_port = 0
- protocol = "-1"
- cidr_blocks = ["0.0.0.0/0"]
- }
+# Create an instance
+resource "aws_instance" "example" {
+ ami = "ami-2757f631"
+ instance_type = "t2.micro"
 }
 
-resource "aws_elb" "web" {
- name = "terraform-example-elb"
-
- subnets = ["${aws_subnet.default.id}"]
- security_groups = ["${aws_security_group.elb.id}"]
- instances = ["${aws_instance.web.id}"]
+';
 
- listener {
- instance_port = 80
- instance_protocol = "http"
- lb_port = 80
- lb_protocol = "http"
+$configObject = (new HCLParser($hcl))->parse();
+
+var_dump($configObject);
+
+/*
+
+object(stdClass)#5 (2) {
+ ["provider"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#4 (1) {
+ ["aws"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#2 (3) {
+ ["access_key"]=>
+ string(17) "${var.access_key}"
+ ["region"]=>
+ string(13) "${var.region}"
+ ["secret_key"]=>
+ string(17) "${var.secret_key}"
+ }
+ }
+ }
  }
-}
-
-resource "aws_key_pair" "auth" {
- key_name = "${var.key_name}"
- public_key = "${file(var.public_key_path)}"
-}
-
-resource "aws_instance" "web" {
- # The connection block tells our provisioner how to
- # communicate with the resource (instance)
- connection {
- # The default username for our AMI
- user = "ubuntu"
-
- # The connection will use the local SSH agent for authentication.
- }
-
- instance_type = "t2.micro"
-
- # Lookup the correct AMI based on the region
- # we specified
- ami = "${lookup(var.aws_amis, var.aws_region)}"
-
- # The name of our SSH keypair we created above.
- key_name = "${aws_key_pair.auth.id}"
-
- # Our Security group to allow HTTP and SSH access
- vpc_security_group_ids = ["${aws_security_group.default.id}"]
-
- # We\'re going to launch into the same subnet as our ELB. In a production
- # environment it\'s more common to have a separate private subnet for
- # backend instances.
- subnet_id = "${aws_subnet.default.id}"
-
- # We run a remote provisioner on the instance after creating it.
- # In this case, we just install nginx and start it. By default,
- # this should be on port 80
- provisioner "remote-exec" {
- inline = [
- "sudo apt-get -y update",
- "sudo apt-get -y install nginx",
- "sudo service nginx start",
- ]
+ ["resource"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#8 (1) {
+ ["aws_instance"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#7 (1) {
+ ["example"]=>
+ array(1) {
+ [0]=>
+ object(stdClass)#6 (2) {
+ ["ami"]=>
+ string(12) "ami-2757f631"
+ ["instance_type"]=>
+ string(8) "t2.micro"
+ }
+ }
+ }
+ }
+ }
  }
 }
-';
-
-$object = (new HCLParser($hcl))->parse();
 
-var_dump($object);
+*/