Skip to content
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

Jump to bottom

(Re-)Run checkout script if workspace was modified #549

Merged
merged 2 commits into from
Jan 10, 2024
Merged

(Re-)Run checkout script if workspace was modified #549

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bacfca0
builder: checkout modifications trigger rebuild
jkloetzke Jan 9, 2024
f04e34f
builder: print checkout reason
jkloetzke Jan 9, 2024
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
39 changes: 32 additions & 7 deletions pym/bob/builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,17 @@
return hashDirectory(step.getStoragePath(),
os.path.join(os.path.dirname(step.getWorkspacePath()), "cache.bin"))

class HashOnce:
def __init__(self, step):
self.step = step
self.result = None
def hashWorkspace(self):
if self.result is None:
self.result = hashWorkspace(self.step)
return self.result
def invalidate(self):
self.result = None

CHECKOUT_STATE_VARIANT_ID = None # Key in checkout directory state for step variant-id
CHECKOUT_STATE_BUILD_ONLY = 1 # Key for checkout state of build-only builds

Expand Down Expand Up @@ -1104,9 +1115,10 @@
checkoutState = checkoutStep.getScmDirectories().copy()
checkoutState[CHECKOUT_STATE_VARIANT_ID] = (checkoutDigest, None)
checkoutState[CHECKOUT_STATE_BUILD_ONLY] = checkoutBuildOnlyState(checkoutStep, checkoutInputHashes)
currentResultHash = HashOnce(checkoutStep)
if self.__buildOnly and (BobState().getResultHash(prettySrcPath) is not None):
inputChanged = checkoutBuildOnlyStateChanged(checkoutState, oldCheckoutState)
rehash = lambda: hashWorkspace(checkoutStep)
rehash = currentResultHash.hashWorkspace
if checkoutStep.mayUpdate(inputChanged, BobState().getResultHash(prettySrcPath), rehash):
if checkoutBuildOnlyStateCompatible(checkoutState, oldCheckoutState):
with stepExec(checkoutStep, "UPDATE",
Expand All @@ -1115,6 +1127,7 @@
newCheckoutState = oldCheckoutState.copy()
newCheckoutState[CHECKOUT_STATE_BUILD_ONLY] = checkoutState[CHECKOUT_STATE_BUILD_ONLY]
BobState().setDirectoryState(prettySrcPath, newCheckoutState)
currentResultHash.invalidate() # force recalculation
else:
stepMessage(checkoutStep, "UPDATE", "WARNING: recipe changed - cannot update ({})"
.format(prettySrcPath), WARNING)
Expand All @@ -1138,10 +1151,21 @@
# Do not use None here to distinguish it from a non-existent directory.
oldCheckoutState[scmDir] = (False, scmSpec)

if (self.__force or (not checkoutStep.isDeterministic()) or
(BobState().getResultHash(prettySrcPath) is None) or
not compareDirectoryState(checkoutState, oldCheckoutState) or
(checkoutInputHashes != BobState().getInputHashes(prettySrcPath))):
oldResultHash = BobState().getResultHash(prettySrcPath)
checkoutReason = None
if self.__force:
checkoutReason = "forced"
elif not checkoutStep.isDeterministic():
checkoutReason = "indeterminsitic"
elif not compareDirectoryState(checkoutState, oldCheckoutState):
checkoutReason = "recipe changed"
elif (checkoutInputHashes != BobState().getInputHashes(prettySrcPath)):
checkoutReason = "input changed"

Check warning on line 1163 in pym/bob/builder.py

View check run for this annotation

Codecov / codecov/patch

pym/bob/builder.py#L1163 

Added line #L1163 was not covered by tests
elif (checkoutStep.getMainScript() or checkoutStep.getPostRunCmds()) \
and (oldResultHash != currentResultHash.hashWorkspace()):
checkoutReason = "workspace changed"

Check warning on line 1166 in pym/bob/builder.py

View check run for this annotation

Codecov / codecov/patch

pym/bob/builder.py#L1166 

Added line #L1166 was not covered by tests

if checkoutReason:
# Switch or move away old or changed source directories. In
# case of nested SCMs the loop relies on the property of
# checkoutsFromState() to return the directories in a top-down
Expand Down Expand Up @@ -1219,10 +1243,11 @@
BobState().setResultHash(prettySrcPath, oldCheckoutHash)

with stepExec(checkoutStep, "CHECKOUT",
"{} {}".format(prettySrcPath, overridesString)) as a:
"{} ({}) {}".format(prettySrcPath, checkoutReason, overridesString)) as a:
await self._runShell(checkoutStep, "checkout", a)
self.__statistic.checkouts += 1
checkoutExecuted = True
currentResultHash.invalidate() # force recalculation
# reflect new checkout state
BobState().setDirectoryState(prettySrcPath, checkoutState)
BobState().setInputHashes(prettySrcPath, checkoutInputHashes)
Expand All @@ -1233,7 +1258,7 @@

# We always have to rehash the directory as the user might have
# changed the source code manually.
checkoutHash = hashWorkspace(checkoutStep)
checkoutHash = currentResultHash.hashWorkspace()

# Generate audit trail before setResultHash() to force re-generation if
# the audit trail fails.
Expand Down
Loading