Implement TerraformConfig

Prodesire · Prodesire · commit 53bcd6908f5b · 2022-03-11T10:27:49.000+08:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,62 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        python-version: [ '3.6', '3.7', '3.8', '3.9', '3.10' ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install poetry
+        run: |
+          python -m pip install poetry
+      - name: Fetch terraform repository
+        run: |
+          git submodule init
+          git submodule update
+      - name: Build distributions
+        run: |
+          poetry build -f wheel -vvv
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: libterraform-dist
+          path: dist
+  publish:
+    needs: [ build ]
+    runs-on: macos-latest
+    steps:
+      - name: Checkout repository code
+        uses: actions/checkout@v2
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: libterraform-dist
+          path: dist
+      - name: Install poetry
+        run: |
+          python -m pip install poetry
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+      - name: Publish to PyPI
+        env:
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $POETRY_PYPI_TOKEN_PYPI
+          poetry publish
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Prodesire
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,19 +1,23 @@
-# py-terraform
+# Python libterraform
+
+[![Release](https://github.com/Prodesire/py-libterraform/actions/workflows/release.yml/badge.svg)](https://github.com/Prodesire/py-libterraform/actions/workflows/release.yml)
+
 Python binding for Terraform.
 
+
 ## Installation
 ```bash
-$ pip install py-terraform
+$ pip install libterraform
 ```
 
 ## Usage
-For now, only supply `load_config_dir` method which reads the .tf and .tf.json files in the given directory
+For now, only supply `TerraformConfig.load_config_dir` method which reads the .tf and .tf.json files in the given directory
 as config files and then combines these files into a single Module. This method returns `(mod, diags)` 
 which are both dict, corresponding to the [*Module](https://github.com/hashicorp/terraform/blob/2a5420cb9acf8d5f058ad077dade80214486f1c4/internal/configs/module.go#L14) 
 and [hcl.Diagnostic](https://github.com/hashicorp/hcl/blob/v2.11.1/diagnostic.go#L26) structures in Terraform respectively.
 ```python
->>> import py_terraform
->>> mod, _ =py_terraform.load_config_dir('tests/config/sleep')
+>>> from libterraform import TerraformConfig
+>>> mod, _ =TerraformConfig.load_config_dir('tests/config/sleep')
 >>> mod['ManagedResources'].keys()
 dict_keys(['time_sleep.wait'])
 ```
diff --git a/build.py b/build.py
@@ -1,12 +1,14 @@
 import os
 import shutil
 import subprocess
+import platform
 
-root = os.path.dirname(os.path.abspath(__file__))
-terraform_dirname = os.path.join(root, 'terraform')
-lib_filename = 'libterraform.so'
+
+lib_filename = 'libterraform.dll' if platform.system() == 'Windows' else 'libterraform.so'
 header_filename = 'libterraform.h'
 tf_filename = 'libterraform.go'
+root = os.path.dirname(os.path.abspath(__file__))
+terraform_dirname = os.path.join(root, 'terraform')
 tf_path = os.path.join(root, tf_filename)
 
 
@@ -15,12 +17,12 @@ class BuildError(Exception):
 
 
 def build(setup_kwargs):
-    '''
+    """
     This function is mandatory in order to build the extensions.
-    '''
-    if not os.path.exists(terraform_dirname):
-        raise BuildError(f'The directory {terraform_dirname} not exists. '
-                         f'Please execute `git submodule update` to get it.')
+    """
+    if not os.path.exists(os.path.join(terraform_dirname, '.git')):
+        raise BuildError(f'The directory {terraform_dirname} not exists or init. '
+                         f'Please execute `git submodule init && git submodule update` to init it.')
 
     target_tf_path = os.path.join(terraform_dirname, tf_filename)
     lib_path = os.path.join(terraform_dirname, lib_filename)
@@ -30,10 +32,9 @@ def build(setup_kwargs):
         print('      - Building libterraform')
         subprocess.check_call(
             ['go', 'build', '-buildmode=c-shared', f'-o={lib_filename}', tf_filename],
-            # shell=True,
             cwd=terraform_dirname
         )
-        shutil.move(lib_path, os.path.join(root, 'py_terraform', lib_filename))
+        shutil.move(lib_path, os.path.join(root, 'libterraform', lib_filename))
     finally:
         for path in (target_tf_path, header_path, lib_path):
             if os.path.exists(path):
diff --git a/libterraform.go b/libterraform.go
@@ -16,6 +16,10 @@ import (
 	"encoding/json"
 )
 
+// **********************************************
+// Config
+// **********************************************
+
 // ShortModule is a container for a set of configuration constructs that are
 // evaluated within a common namespace.
 // Compared with module, there are fewer non-serializable fields.
@@ -62,15 +66,14 @@ func convertModule(mod *configs.Module) *ShortModule {
 	return shortMod
 }
 
-//export LoadConfigDir
-func LoadConfigDir(cPath *C.char) (cMod *C.char, cDiags *C.char, cError *C.char) {
+//export ConfigLoadConfigDir
+func ConfigLoadConfigDir(cPath *C.char) (cMod *C.char, cDiags *C.char, cError *C.char) {
 	defer func() {
 		recover()
 	}()
 
 	parser := configs.NewParser(nil)
 	path := C.GoString(cPath)
-	//fmt.Println(path)
 	mod, diags := parser.LoadConfigDir(path)
 	modBytes, err := json.Marshal(convertModule(mod))
 	if err != nil {
@@ -89,10 +92,13 @@ func LoadConfigDir(cPath *C.char) (cMod *C.char, cDiags *C.char, cError *C.char)
 	cMod = C.CString(string(modBytes))
 	cDiags = C.CString(string(diagsBytes))
 	cError = C.CString("")
-	//fmt.Println(string(modBytes), string(diagsBytes))
 	return cMod, cDiags, cError
 }
 
+// **********************************************
+// Utils
+// **********************************************
+
 //export Free
 func Free(cString *int) {
 	C.free(unsafe.Pointer(cString))
diff --git a/libterraform/__init__.py b/libterraform/__init__.py
@@ -0,0 +1,16 @@
+import os
+import platform
+from ctypes import cdll, c_void_p
+
+__version__ = '0.1.0'
+
+root = os.path.dirname(os.path.abspath(__file__))
+_lib_filename = 'libterraform.dll' if platform.system() == 'Windows' else 'libterraform.so'
+_lib_tf = cdll.LoadLibrary(os.path.join(root, _lib_filename))
+
+_free = _lib_tf.Free
+_free.argtypes = [c_void_p]
+
+from .config import TerraformConfig
+
+__all__ = [TerraformConfig]
diff --git a/libterraform/config.py b/libterraform/config.py
@@ -0,0 +1,46 @@
+import json
+from ctypes import *
+
+from libterraform import _lib_tf, _free
+from libterraform.exceptions import LibTerraformError
+
+
+class LoadConfigDirResult(Structure):
+    _fields_ = [("r0", c_void_p),
+                ("r1", c_void_p),
+                ("r2", c_void_p)]
+
+
+_load_config_dir = _lib_tf.ConfigLoadConfigDir
+_load_config_dir.argtypes = [c_char_p]
+_load_config_dir.restype = LoadConfigDirResult
+
+
+class TerraformConfig:
+    @staticmethod
+    def load_config_dir(path: str) -> (dict, dict):
+        """
+        load_config_dir reads the .tf and .tf.json files in the given directory
+        as config files and then combines these files into a single Module.
+
+        .tf files are parsed using the HCL native syntax while .tf.json files are
+        parsed using the HCL JSON syntax.
+        """
+        ret = _load_config_dir(path.encode('utf-8'))
+        r_mod = cast(ret.r0, c_char_p).value
+        _free(ret.r0)
+        r_diags = cast(ret.r1, c_char_p).value
+        _free(ret.r1)
+        err = cast(ret.r2, c_char_p).value
+        _free(ret.r2)
+
+        if err:
+            raise LibTerraformError(err)
+        if r_mod is None:
+            msg = f'The given directory {path!r} does not exist at all or could not be opened for some reason.'
+            raise LibTerraformError(msg)
+
+        mod = json.loads(r_mod)
+        diags = json.loads(r_diags)
+
+        return mod, diags
diff --git a/libterraform/exceptions.py b/libterraform/exceptions.py
@@ -0,0 +1,2 @@
+class LibTerraformError(Exception):
+    pass
diff --git a/py_terraform/__init__.py b/py_terraform/__init__.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,13 +1,13 @@
 [tool.poetry]
-name = "py-terraform"
-version = "0.0.1"
-description = "Python binding for Terraform"
+name = "libterraform"
+version = "0.1.0"
+description = "Python binding for Terraform."
 authors = ["Prodesire <wangbinxin001@126.com>"]
 license = "MIT"
 readme = "README.md"
-homepage = "https://github.com/Prodesire/py-terraform"
-repository = "https://github.com/Prodesire/py-terraform"
-keywords = ["py-terraform", "terraform"]
+homepage = "https://github.com/Prodesire/py-libterraform"
+repository = "https://github.com/Prodesire/py-libterraform"
+keywords = ["libterraform", "terraform"]
 classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
@@ -25,8 +25,9 @@ classifiers = [
     "Operating System :: Microsoft :: Windows"
 ]
 packages = [
-    { include = "py_terraform/*" },
+    { include = "libterraform/*" },
 ]
+include = ["libterraform/libterraform.so", "libterraform/libterraform.dll"]
 
 [tool.poetry.dependencies]
 python = "^3.6"
diff --git a/tests/config/test_load_config_dir.py b/tests/config/test_load_config_dir.py
@@ -2,17 +2,18 @@
 
 import pytest
 
-import py_terraform
+from libterraform import TerraformConfig
+from libterraform.exceptions import LibTerraformError
 
 cur_dirname = os.path.dirname(os.path.abspath(__file__))
 sleep_dirname = os.path.join(cur_dirname, 'sleep')
 
 
-def test_load_config_dir():
-    mod, diags = py_terraform.load_config_dir(sleep_dirname)
-    assert 'time_sleep.wait' in mod['ManagedResources']
+class TestTerraformConfig:
+    def test_load_config_dir(self):
+        mod, diags = TerraformConfig.load_config_dir(sleep_dirname)
+        assert 'time_sleep.wait' in mod['ManagedResources']
 
-
-def test_load_config_dir_no_exits():
-    with pytest.raises(py_terraform.LibTerraformError):
-        py_terraform.load_config_dir('not-exits')
+    def test_load_config_dir_no_exits(self):
+        with pytest.raises(LibTerraformError):
+            TerraformConfig.load_config_dir('not-exits')

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+class LibTerraformError(Exception):`
	`2`	`+ pass`