Merge pull request VDOO-Connected-Trust#10 from fmagin/ci_build

Ci build

Author: tmr232

.github/workflows/publish.yml

@@ -0,0 +1,68 @@
+name: Publish Tagged Commit to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python Package
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.11
+
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "2.7"
+
+      - uses: er28-0652/setup-ghidra@master
+        with:
+          version: "9.2.2"
+
+      - name: Prepare Jython Environment
+        run:
+          pip2.7 install --target="$GHIDRA_INSTALL_DIR/Ghidra/Features/Python/data/jython-2.7.2/Lib/site-packages" attrs typing
+
+      - name: Build Package
+        run: |
+          "$GHIDRA_INSTALL_DIR/support/analyzeHeadless" /tmp tmp -scriptPath $(pwd) -preScript generate_ghidra_pyi.py ./ ${GITHUB_REF#refs/*/}
+          test -f setup.py # check manually, because analyzeHeadless doesn't fail on script failure
+          test -d ghidra-stubs
+
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          wheel
+          --user
+
+      - name: Build a binary wheel and a source tarball
+        run: |
+          python setup.py bdist_wheel --universal
+          python setup.py sdist
+
+# TODO: Setup publishing to PyPI by creating package and token and adding to GitHub secrets
+#      - name: Publish distribution 📦 to PyPI
+#        uses: pypa/gh-action-pypi-publish@master
+#        with:
+#          password: ${{ secrets.PYPI_API_TOKEN }}
+
+
+      - name: Release on GitHub
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ./dist/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,2 +1,3 @@
 *$py.class
 *.pyi
+.idea

README.md

@@ -6,9 +6,18 @@ Those stub files can later be used in PyCharm to enhance the development experie
 
 You can either use the stubs released [here][latest-release], or follow the instructions below to generate them yourself.
 
-To use the stubs in PyCharm, follow the instructions in [Install, uninstall, and upgrade interpreter paths][interpreter-paths].
 
-### Using The Stubs
+## Using The Stubs
+
+### Installation 
+
+The release contains  [PEP 0561 stub package][pep-0561], which can simply be installed with `pip install ghidra-stubs*.whl`
+into the environment in which the real `ghidra` module is available. Any conformant tool will then use the stub package
+for type analysis purposes.  
+
+If you want to manually add the stub files to PyCharm, follow the instructions in [Install, uninstall, and upgrade interpreter paths][interpreter-paths].
+
+### Usage
 
 Once installed, all you need to do is import the Ghidra modules as usual, and PyCharm will do the rest.
 
@@ -22,11 +31,27 @@ But the `.pyi` gives PyCharm all the information it needs to help you.
 
 ```python
 try:
-    from ghidra_builtins import *
+    from ghidra.ghidra_builtins import *
 except:
     pass
 ```
 
+If you are using [ghidra_bridge](https://github.com/justfoxing/ghidra_bridge) from a Python 3 environment where no real `ghidra` module
+exists you can use a snippet like the following:
+
+```python
+import typing
+if typing.TYPE_CHECKING:
+    import ghidra
+    from ghidra.ghidra_builtins import *
+else:
+    b = ghidra_bridge.GhidraBridge(namespace=globals())
+
+# actual code follows here
+```
+
+`typing.TYPE_CHECKING` is a special value that is always `False` at runtime but `True` during any kind of type checking or completion.
+
 Once done, just code & enjoy.
 
 ![Pycharm Demo][pycharm-demo]

generate_ghidra_pyi.py

@@ -4,6 +4,11 @@
 import type_formatter
 
 import ghidra
+# Make this script work with the stubs in an IDE
+try:
+    from ghidra.ghidra_builtins import *
+except:
+    pass
 from __main__ import askDirectory, askYesNo, getGhidraVersion
 
 from generate_stub_package import generate_package
@@ -35,7 +40,16 @@ def main():
     ghidra_package = type_extractor.Package.from_package(ghidra)
     type_formatter.create_type_hints(pyi_root, ghidra_package)
 
-    generate_package(pyi_root, getGhidraVersion())
+    package_version = "DEV"
+    if isRunningHeadless():
+        # We are running in an headless environment and this might be an automated CI build
+        # so we try getting an extra argument that is supposed to be the git commit tag so the package version is a combination
+        # of the ghidra version and the version of the stub generating code
+        try:
+            package_version = askString("Package version", "Please specify package version")
+        except:
+            pass
+    generate_package(pyi_root, getGhidraVersion(), stub_version=package_version)
 
 if __name__ == '__main__':
     main()

generate_stub_package.py

@@ -2,7 +2,7 @@
 import shutil
 
 
-def generate_package(pyi_root, ghidra_version):
+def generate_package(pyi_root, ghidra_version, stub_version="DEV"):
 
     setup_code = """
 from setuptools import setup
@@ -19,11 +19,12 @@ def find_stub_files():
     return result
 
 setup(name= 'ghidra-stubs',
-version='{ghidra_version}',
+version='{ghidra_version}_{stub_version}',
 author='Tamir Bahar',
 packages=['ghidra-stubs'],
 package_data={{'ghidra-stubs': find_stub_files()}})
-    """.format(ghidra_version=ghidra_version)
+    """.format(ghidra_version=ghidra_version,
+               stub_version=stub_version)
 
     stub_folder = os.path.join(pyi_root, 'ghidra-stubs')
     os.rename(os.path.join(pyi_root, 'ghidra'), stub_folder)

type_extractor.py

@@ -39,6 +39,8 @@ def get_members(obj):
         except java.lang.IllegalArgumentException:
             # Some values cannot be converted to Python types, so we are stuck.
             pass
+        except java.lang.NoClassDefFoundError:
+            pass
 
     # If something is in `__dict__` we want it directly from there.
     # Attribute resolution destroys reflection info when class fields are involved.
@@ -86,10 +88,10 @@ def from_reflected_args(reflected_args, ctor_for=None, docs=None):
         if ctor_for is not None:
             return_type = ctor_for
         else:
-            return_type = reflected_args.data.getReturnType()
+            return_type = reflected_args.method.getReturnType()
 
         return_type = BasicType.from_type(return_type)
-        argument_types = map(BasicType.from_type, reflected_args.data.getParameterTypes())
+        argument_types = map(BasicType.from_type, reflected_args.method.getParameterTypes())
 
         argument_names = get_argument_names(argument_types, docs)