fix: Omit hash to make shebangs stable

Author: codablock

embed_util/embedded_files.go

@@ -18,14 +18,14 @@ type EmbeddedFiles struct {
 
 func NewEmbeddedFiles(embedFs fs.FS, name string) (*EmbeddedFiles, error) {
 	tmpDir := filepath.Join(os.TempDir(), fmt.Sprintf("go-embedded-%s", name))
-	return NewEmbeddedFilesWithTmpDir(embedFs, tmpDir)
+	return NewEmbeddedFilesWithTmpDir(embedFs, tmpDir, true)
 }
 
-func NewEmbeddedFilesWithTmpDir(embedFs fs.FS, tmpDir string) (*EmbeddedFiles, error) {
+func NewEmbeddedFilesWithTmpDir(embedFs fs.FS, tmpDir string, withHashInDir bool) (*EmbeddedFiles, error) {
 	e := &EmbeddedFiles{
 		tmpDir: tmpDir,
 	}
-	err := e.extract(embedFs)
+	err := e.extract(embedFs, withHashInDir)
 	if err != nil {
 		return nil, err
 	}
@@ -45,16 +45,19 @@ func (e *EmbeddedFiles) GetExtractedPath() string {
 	return e.extractedPath
 }
 
-func (e *EmbeddedFiles) extract(embedFs fs.FS) error {
+func (e *EmbeddedFiles) extract(embedFs fs.FS, withHashInDir bool) error {
 	fl, err := e.readOrBuildFileList(embedFs)
 	if err != nil {
 		return err
 	}
 
 	flHash := fl.Hash()
 
-	e.extractedPath = fmt.Sprintf("%s-%s", e.tmpDir, flHash[:16])
-
+	if withHashInDir {
+		e.extractedPath = fmt.Sprintf("%s-%s", e.tmpDir, flHash[:16])
+	} else {
+		e.extractedPath = e.tmpDir
+	}
 	err = os.MkdirAll(filepath.Dir(e.extractedPath), 0o755)
 	if err != nil {
 		return err

pip/embed_pip_packages.go

@@ -38,8 +38,9 @@ func CreateEmbeddedPipPackagesForKnownPlatforms(requirementsFile string, targetD
 func CreateEmbeddedPipPackages(requirementsFile string, goOs string, goArch string, pipPlatform string, targetDir string) error {
 	name := fmt.Sprintf("pip-%d", rand.Uint32())
 
+	// ensure we have a stable extract path for the python distribution (otherwise shebangs won't be stable)
 	tmpDir := filepath.Join("/tmp", fmt.Sprintf("python-pip-%s-%s-%s", goOs, goArch, pipPlatform))
-	ep, err := python.NewEmbeddedPythonWithTmpDir(tmpDir)
+	ep, err := python.NewEmbeddedPythonWithTmpDir(tmpDir, false)
 	if err != nil {
 		return err
 	}

pip/internal/data/bin/pip

@@ -1,4 +1,4 @@
-#!/tmp/python-pip-bootstrap-5c6cf816674ccbfc/bin/python3
+#!/tmp/python-pip-bootstrap/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys

pip/internal/data/bin/pip3

@@ -1,4 +1,4 @@
-#!/tmp/python-pip-bootstrap-5c6cf816674ccbfc/bin/python3
+#!/tmp/python-pip-bootstrap/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys

pip/internal/data/bin/pip3.10

@@ -1,4 +1,4 @@
-#!/tmp/python-pip-bootstrap-5c6cf816674ccbfc/bin/python3
+#!/tmp/python-pip-bootstrap/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys

pip/internal/data/files.json

@@ -1,5 +1,5 @@
 {
-  "contentHash": "ddb6050d1e62d6a81c9438bd4118e8055173643010027a560d90f18677aaef72",
+  "contentHash": "3f6de938b00ecbf872b793f2706363826bd3dafbfcd6aff02416fcf8a0aa37f4",
   "files": [
     {
       "name": "bin",
@@ -8,17 +8,17 @@
     },
     {
       "name": "bin/pip",
-      "size": 259,
+      "size": 242,
       "perm": 493
     },
     {
       "name": "bin/pip3",
-      "size": 259,
+      "size": 242,
       "perm": 493
     },
     {
       "name": "bin/pip3.10",
-      "size": 259,
+      "size": 242,
       "perm": 493
     },
     {

pip/internal/data/pip-22.2.2.dist-info/RECORD

@@ -1,6 +1,6 @@
-../../bin/pip,sha256=jCQZi6-1GMDo6yUEXEUko3I_Pft-OiueRN9OXP5n3rw,259
-../../bin/pip3,sha256=jCQZi6-1GMDo6yUEXEUko3I_Pft-OiueRN9OXP5n3rw,259
-../../bin/pip3.10,sha256=jCQZi6-1GMDo6yUEXEUko3I_Pft-OiueRN9OXP5n3rw,259
+../../bin/pip,sha256=wRjnmyTponr89E3KA0MjgmNQrPS4Gl3I0nHz5H9xb2s,242
+../../bin/pip3,sha256=wRjnmyTponr89E3KA0MjgmNQrPS4Gl3I0nHz5H9xb2s,242
+../../bin/pip3.10,sha256=wRjnmyTponr89E3KA0MjgmNQrPS4Gl3I0nHz5H9xb2s,242
 pip-22.2.2.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
 pip-22.2.2.dist-info/LICENSE.txt,sha256=Y0MApmnUmurmWxLGxIySTFGkzfPR_whtw0VtyLyqIQQ,1093
 pip-22.2.2.dist-info/METADATA,sha256=1THNkoBHocZtVQ8SixJH12wuSXHJIQb4Vu7RzzEjfKQ,4197

pip/internal/generate/main.go

@@ -13,8 +13,9 @@ import (
 func main() {
 	targetDir := "./pip/internal/data"
 
+	// ensure we have a stable extract path for the python distribution (otherwise shebangs won't be stable)
 	tmpDir := filepath.Join("/tmp", fmt.Sprintf("python-pip-bootstrap"))
-	ep, err := python.NewEmbeddedPythonWithTmpDir(tmpDir)
+	ep, err := python.NewEmbeddedPythonWithTmpDir(tmpDir, false)
 	if err != nil {
 		panic(err)
 	}

python/embedded_python.go

@@ -30,8 +30,8 @@ func NewEmbeddedPython(name string) (*EmbeddedPython, error) {
 	}, nil
 }
 
-func NewEmbeddedPythonWithTmpDir(tmpDir string) (*EmbeddedPython, error) {
-	e, err := embed_util.NewEmbeddedFilesWithTmpDir(data.Data, tmpDir)
+func NewEmbeddedPythonWithTmpDir(tmpDir string, withHashInDir bool) (*EmbeddedPython, error) {
+	e, err := embed_util.NewEmbeddedFilesWithTmpDir(data.Data, tmpDir, withHashInDir)
 	if err != nil {
 		return nil, err
 	}