Merge pull request #19 from aboutcode-org/build-src

Build src

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+v0.5.0 (2024-11-05)
+-------------------
+
+- Build GoReSym from source instead of vendoring the binary.
+- Support building go-inspector for Linux aarch64/arm64 platform.
+- Update GoReSym to v3.0.1
 
 v0.4.0 (2024-10-31)
 -------------------

Makefile

@@ -13,6 +13,15 @@ PYTHON_EXE?=python3
 VENV=venv
 ACTIVATE?=. ${VENV}/bin/activate;
 
+ARCH := $(shell uname -m)
+ifeq ($(ARCH),aarch64)
+	PLAT_NAME := "manylinux2014_aarch64"
+	GOARCH := "arm64"
+else
+	PLAT_NAME := "manylinux1_x86_64"
+	GOARCH := "amd64"
+endif
+
 dev:
 	@echo "-> Configure the development envt."
 	./configure --dev
@@ -35,7 +44,7 @@ check:
 	@echo "-> Run pycodestyle (PEP8) validation"
 	@${ACTIVATE} pycodestyle --max-line-length=100 --exclude=.eggs,venv,lib,thirdparty,docs,migrations,settings.py,.cache .
 	@echo "-> Run isort imports ordering validation"
-	@${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests . 
+	@${ACTIVATE} isort --sl --check-only -l 100 setup.py src tests .
 	@echo "-> Run black validation"
 	@${ACTIVATE} black --check --check -l 100 src tests setup.py
 
@@ -51,4 +60,9 @@ docs:
 	rm -rf docs/_build/
 	@${ACTIVATE} sphinx-build docs/ docs/_build/
 
+build:
+	rm -f src/go_inspector/bin/GoReSym_lin
+	python setup.py clean --all sdist
+	GOOS=linux GOARCH=$(GOARCH) python setup.py clean --all bdist_wheel --python-tag py3 --plat-name $(PLAT_NAME)
+
 .PHONY: conf dev check valid black isort clean test docs

README.rst

@@ -11,12 +11,14 @@ To install and use:
 
 The JSON output will contain various dependencies and symbols found in Go binaries if any.
 
+A Go compiler is required to build go-inspector. Install Go from
+https://go.dev/doc/install or from a package manager.
 
 - License: Apache-2.0 AND MIT AND BSD-3-Clause WITH LicenRef-scancode-google-patent-license-golang
 - Copyright (c) nexB Inc., AboutCode, Mandiant, The Go Authors, Elliot Chance and others.
 - Homepage: https://github.com/aboutcode-org/go-inspector
 
-See the src/go_inspector/bin for detailed license and credits for bundled third-party packages.
+See the libsrc/ directory for detailed license and credits for bundled third-party packages.
 
 
 Development
@@ -31,6 +33,9 @@ Testing:
 - To regen test fixtures: ``SCANCODE_REGEN_TEST_FIXTURES=yes pytest -vvs``
 - To update the bundled GoReSym, see src/bin/update.sh
 
+Building:
+
+- Ensure ``make dev`` has been run, then run ``make build``
 
 How to re-generate test binaries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,27 +55,27 @@ This project is funded, supported and sponsored by:
 
 - Generous support and contributions from users like you!
 - the European Commission NGI programme
-- the NLnet Foundation 
+- the NLnet Foundation
 - the Swiss State Secretariat for Education, Research and Innovation (SERI)
 - Google, including the Google Summer of Code and the Google Seasons of Doc programmes
 - Mercedes-Benz Group
 - Microsoft and Microsoft Azure
 - AboutCode ASBL
-- nexB Inc. 
+- nexB Inc.
 
 
 
-|europa|   |dgconnect| 
+|europa|   |dgconnect|
 
-|ngi|   |nlnet|   
+|ngi|   |nlnet|
 
 |aboutcode|  |nexb|
 
 
 
 This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
 support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101069594. 
+Communications Networks, Content and Technology under grant agreement No 101069594.
 
 |ngizeroentrust| https://nlnet.nl/project/Back2source/
 
@@ -84,7 +89,7 @@ Communications Networks, Content and Technology under grant agreement No 1010929
 
 This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
 support from the European Commission's Next Generation Internet programme, under the aegis of DG
-Communications Networks, Content and Technology under grant agreement No 101069594. 
+Communications Networks, Content and Technology under grant agreement No 101069594.
 
 |ngizeroentrust| https://nlnet.nl/project/purl2all/
 

build.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) nexB Inc. http://www.nexb.com/ - All rights reserved.
+#
+
+set -e
+
+base_name=GoReSym-3.0.1
+GOOS=linux
+
+if [ $(uname -m) == 'aarch64' ]; then
+    GOARCH="arm64"
+else
+    GOARCH="amd64"
+fi
+
+cd lib-src/
+
+rm -rf $base_name
+tar -xf $base_name.tar.gz
+
+cd $base_name/
+
+echo Build GoReSym
+go build && mv GoReSym GoReSym_lin
+strip GoReSym_lin
+cp GoReSym_lin ../../src/go_inspector/bin/
+cd ..
+echo Done building GoReSym
+
+rm -rf $base_name/

lib-src/GoReSym-3.0.1.tar.gz.ABOUT

@@ -0,0 +1,8 @@
+about_resource: GoReSym-3.0.1.tar.gz
+name: GoReSym
+version: 3.0.1
+download_url: https://github.com/mandiant/GoReSym/archive/refs/tags/v3.0.1.tar.gz
+package_url: pkg:github/mandiant/[email protected]
+copyright: Copyright (c) 2022 MANDIANT
+license_expression: mit
+license_text_file: GoReSym_lin.LICENSE

lib-src/GoReSym-3.0.1.tar.gz.LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MANDIANT
+
+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.

setup.py

@@ -1,6 +1,31 @@
 #!/usr/bin/env python
 
+import subprocess
+from distutils.command.build import build as distutils_build
+from distutils.errors import LibError
+
 import setuptools
+from setuptools.command.develop import develop as setuptools_develop
+
+
+def run_native_build():
+    exitcode, output = subprocess.getstatusoutput(["./build.sh"])
+    print(output)
+    if exitcode:
+        raise LibError("Unable to build native")
+
+
+class BuildNative(distutils_build):
+    def run(self):
+        self.execute(run_native_build, (), msg="Building native code")
+        distutils_build.run(self)
+
+
+class DevelopNative(setuptools_develop):
+    def run(self):
+        self.execute(run_native_build, (), msg="Building develop native code")
+        setuptools_develop.run(self)
+
 
 if __name__ == "__main__":
-    setuptools.setup()
+    setuptools.setup(cmdclass={"build": BuildNative, "develop": DevelopNative})

src/go_inspector/bin/GoReSym_lin.ABOUT

@@ -1,10 +1,8 @@
 about_resource: GoReSym_lin
-name: goresym
-version: 011fc7d5c9c2362871dfe88a1295a43ee6b4d273
-download_url: https://github.com/pombredanne/GoReSym/archive/011fc7d5c9c2362871dfe88a1295a43ee6b4d273.zip
-package_url: pkg:github/pombredanne/GoReSym@011fc7d5c9c2362871dfe88a1295a43ee6b4d273
+name: GoReSym
+version: 3.0.1
+package_url: pkg:github/mandiant/[email protected]
 copyright: Copyright (c) 2022 MANDIANT
 license_expression: mit
 license_text_file: GoReSym_lin.LICENSE
-notes: this is a patched version until https://github.com/mandiant/GoReSym/pull/60 is accepted
- and merged.
+notes: this is built from the source files contained in the go-inspector/lib-src directory

src/go_inspector/bin/GoReSym_lin.LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.