Fix memory leak

Author: Prodesire

.gitignore

@@ -34,6 +34,6 @@ coverage.txt
 
 # Terraform
 .terraform
-.terraform.lock.hcl
+.terraform.*
 *.tfplan
 *.tfstate

.gitmodules

@@ -2,3 +2,7 @@
 	path = terraform
 	url = https://github.com/hashicorp/terraform
 	shallow = true
+[submodule "go-plugin"]
+	path = go-plugin
+	url = https://github.com/hashicorp/go-plugin
+	shallow = true

README.md

@@ -3,7 +3,7 @@
 [![libterraform](https://img.shields.io/pypi/v/libterraform.svg)](https://pypi.python.org/pypi/libterraform)
 [![libterraform](https://img.shields.io/pypi/l/libterraform.svg)](https://pypi.python.org/pypi/libterraform)
 [![libterraform](https://img.shields.io/pypi/pyversions/libterraform.svg)](https://pypi.python.org/pypi/libterraform)
-[![Release](https://github.com/Prodesire/py-libterraform/actions/workflows/release.yml/badge.svg)](https://github.com/Prodesire/py-libterraform/actions/workflows/release.yml)
+[![Test](https://github.com/Prodesire/py-libterraform/actions/workflows/test.yml/badge.svg)](https://github.com/Prodesire/py-libterraform/actions/workflows/release.yml)
 [![libterraform](https://img.shields.io/pypi/dm/libterraform)](https://pypi.python.org/pypi/libterraform)
 
 Python binding for [Terraform](https://www.terraform.io/).
@@ -14,6 +14,10 @@ Python binding for [Terraform](https://www.terraform.io/).
 $ pip install libterraform
 ```
 
+> **NOTE**
+> - Please install version **0.3.1** or above, which solves the memory leak problem.
+> - This library does **not support** multithreading.
+
 ## Usage
 
 ### Terraform CLI

build.py

@@ -10,6 +10,10 @@
 terraform_dirname = os.path.join(root, 'terraform')
 tf_path = os.path.join(root, tf_filename)
 tf_package_name = 'github.com/hashicorp/terraform'
+plugin_patch_filename = 'plugin_patch.go'
+plugin_dirname = os.path.join(root, 'go-plugin')
+plugin_patch_path = os.path.join(root, plugin_patch_filename)
+plugin_package_name = 'github.com/hashicorp/go-plugin'
 
 
 class BuildError(Exception):
@@ -23,10 +27,27 @@ def build(setup_kwargs):
     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.')
+    if not os.path.exists(os.path.join(plugin_dirname, '.git')):
+        raise BuildError(f'The directory {plugin_dirname} not exists or init. '
+                         f'Please execute `git submodule init && git submodule update` to init it.')
 
+    target_plugin_patch_path = os.path.join(plugin_dirname, plugin_patch_filename)
     target_tf_path = os.path.join(terraform_dirname, tf_filename)
+    target_tf_mod_path = os.path.join(terraform_dirname, 'go.mod')
     lib_path = os.path.join(terraform_dirname, lib_filename)
     header_path = os.path.join(terraform_dirname, header_filename)
+
+    # Patch go-plugin
+    print('      - Patching go-plugin package')
+    shutil.copyfile(plugin_patch_path, target_plugin_patch_path)
+    with open(target_tf_mod_path) as f:
+        mod_content = f.read()
+    with open(target_tf_mod_path, 'w') as f:
+        modified_mod_content = f'{mod_content}\n' \
+                               f'replace github.com/hashicorp/go-plugin v1.4.3 => ../go-plugin'
+        f.write(modified_mod_content)
+
+    # Build libterraform
     shutil.copyfile(tf_path, target_tf_path)
     try:
         print('      - Building libterraform')
@@ -36,9 +57,13 @@ def build(setup_kwargs):
         )
         shutil.move(lib_path, os.path.join(root, 'libterraform', lib_filename))
     finally:
-        for path in (target_tf_path, header_path, lib_path):
+        # Remove external files
+        for path in (target_plugin_patch_path, target_tf_path, header_path, lib_path):
             if os.path.exists(path):
                 os.remove(path)
+        # Recover go.mod
+        with open(target_tf_mod_path, 'w') as f:
+            f.write(mod_content)
 
     return setup_kwargs