Skip to content

Preamble: continue if .pex is outside a Please repo #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisnovakovic merged 1 commit into from
Dec 4, 2025
Merged

Preamble: continue if .pex is outside a Please repo #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions tools/please_pex/preamble/path.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ err_t *get_pex_path(char **pex_path) {
* directory (which is assumed to be the value of TMP_DIR in the environment, as created by Please).
* Otherwise, get_plz_bin_path returns the path to the bin/ subdirectory within the plz-out/ directory
* to which this .pex file belongs. If the .pex file does not exist within a plz-out/ directory
* tree, get_plz_bin_path fails.
* tree, get_plz_bin_path stores NULL in path.
*/
err_t *get_plz_bin_path(char **path) {
char *pex_path = NULL;
Expand All @@ -90,6 +90,8 @@ err_t *get_plz_bin_path(char **path) {
size_t tmp_dir_len = 0;
err_t *err = NULL;

(*path) = NULL;

if ((err = get_pex_path(&pex_path)) != NULL) {
err = err_wrap("get_pex_path", err);
goto end;
Expand Down Expand Up @@ -141,8 +143,7 @@ err_t *get_plz_bin_path(char **path) {
}
if (STREQ(pex_dir, "/") || STREQ(pex_dir, ".")) {
// If we reached the left-most component in the path, the .pex file doesn't exist within a
// plz-out/ directory tree.
err = err_from_str(".pex file is in neither a Please build environment nor a Please repo");
// plz-out/ directory tree - return NULL.
goto end;
}
MALLOC(*path, char, strlen(pex_dir) + strlen("/bin") + 1);
Expand Down
34 changes: 27 additions & 7 deletions tools/please_pex/preamble/preamble.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#include <errno.h>
#include <stdbool.h>
#include <unistd.h>

#include "cJSON.h"
Expand Down Expand Up @@ -211,9 +212,11 @@ static err_t *get_interpreter_args(const cJSON *config, int *len, strlist_t **ar
*/
static err_t *get_interpreters(const cJSON *config, strlist_t **interps) {
strlist_elem_t *interp = NULL;
bool tried_plz_bin_path = false;
char *plz_bin_path = NULL;
const cJSON *json_interps = NULL;
const cJSON *json_interp = NULL;
int added = 0;
err_t *err = NULL;

json_interps = cJSON_GetObjectItemCaseSensitive(config, "interpreters");
Expand All @@ -235,30 +238,47 @@ static err_t *get_interpreters(const cJSON *config, strlist_t **interps) {
goto end;
}

STAILQ_ENTRY_NEW(interp, strlist_elem_t);

if (STRPREFIX(json_interp->valuestring, "$PLZ_BIN_PATH/")) {
if (plz_bin_path == NULL) {
if (!tried_plz_bin_path) {
tried_plz_bin_path = true;

if ((err = get_plz_bin_path(&plz_bin_path)) != NULL) {
err = err_wrap("PLZ_BIN_PATH resolution failure", err);
err = err_wrap("$PLZ_BIN_PATH resolution failure", err);
goto end;
}
log_debug("Resolved $PLZ_BIN_PATH to %s", plz_bin_path);

if (plz_bin_path == NULL) {
log_warn(".pex file is not inside a Please repo; omitting interpreters prepended with '$PLZ_BIN_PATH'");
} else {
log_debug("Resolved $PLZ_BIN_PATH to %s", plz_bin_path);
}
}

if (plz_bin_path == NULL) {
log_info("Omitting interpreter from search path: %s", json_interp->valuestring);
continue;
}

// Replace "$PLZ_BIN_PATH" with the path to Please's binary outputs directory at the
// start of the interpreter path.
STAILQ_ENTRY_NEW(interp, strlist_elem_t);
MALLOC(interp->str, char, strlen(plz_bin_path) + JSON_STRLEN(json_interp) - strlen("$PLZ_BIN_PATH") + 1); // 1 extra byte for trailing null
strncpy(interp->str, plz_bin_path, strlen(plz_bin_path));
strcpy(interp->str + strlen(plz_bin_path), json_interp->valuestring + strlen("$PLZ_BIN_PATH"));
STAILQ_INSERT_TAIL(*interps, interp, next);
} else {
STAILQ_ENTRY_NEW(interp, strlist_elem_t);
MALLOC(interp->str, char, JSON_STRLEN(json_interp) + 1); // 1 extra byte for trailing null
strcpy(interp->str, json_interp->valuestring);
STAILQ_INSERT_TAIL(*interps, interp, next);
}

STAILQ_INSERT_TAIL(*interps, interp, next);

log_debug("Added interpreter to search path: %s", interp->str);
added++;
}

if (added == 0) {
err = err_from_str("interpreters list contains no resolvable paths");
}

end:
Expand Down