Repository navigation
feat: export Python scripts that import their helpers from texera-helpers #9240
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.
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
Open
kz930
wants to merge
8
commits into
apache:main
Choose a base branch
from
kz930:feat/texera-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
90fb458
feat: export Python scripts that import their helpers from texera-sup…
kz930 e386422
feat: keep only the module the zip download needs
kz930 c3f94c3
refactor: name the shared helpers after the module, not a package
kz930 7d0d74d
Merge remote-tracking branch 'upstream/main' into feat/texera-support
kz930 ca9b265
feat: name the exported helper module texera_helpers
kz930 52d9450
feat(frontend): say the copied script needs texera_helpers.py
kz930 50af782
ci: rerun checks after a macOS frontend timeout
kz930 39ff088
fix(export): keep sources off the file names the zip holds
kz930 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
...flow-operator/src/test/scala/org/apache/texera/amber/operator/StandaloneHelpersSpec.scala
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.texera.amber.operator | ||
|
|
||
| import org.scalatest.flatspec.AnyFlatSpec | ||
| import org.scalatest.matchers.should.Matchers | ||
|
|
||
| import java.nio.charset.StandardCharsets | ||
| import java.nio.file.{Files, Path} | ||
|
|
||
| /** The `texera_helpers` module against the helpers the operators declare. */ | ||
| class StandaloneHelpersSpec extends AnyFlatSpec with Matchers { | ||
|
|
||
| private val module: Path = Path | ||
| .of(sys.env.getOrElse("TEXERA_HOME", ".")) | ||
| .resolve("texera-helpers") | ||
| .resolve("texera_helpers") | ||
| .resolve("__init__.py") | ||
|
|
||
| // With TEXERA_HELPERS_WRITE set, the module is rewritten instead of checked. | ||
| "texera_helpers/__init__.py" should "hold exactly the helpers the operators declare" in { | ||
| if (sys.env.contains("TEXERA_HELPERS_WRITE")) { | ||
| Files.write(module, StandaloneHelpers.helpersModule.getBytes(StandardCharsets.UTF_8)) | ||
| } | ||
| withClue(s"$module is stale; rerun this spec with TEXERA_HELPERS_WRITE=1 to rewrite it.\n") { | ||
| new String(Files.readAllBytes(module), StandardCharsets.UTF_8) shouldBe | ||
| StandaloneHelpers.helpersModule | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| # texera-helpers | ||
|
|
||
| The helpers a Python script exported from a Texera workflow calls, so the | ||
| script gives the answers the Texera engine gives. | ||
|
|
||
| An exported script imports the helpers it calls from this module. The export | ||
| downloads as a zip that holds it as `texera_helpers.py` next to the script, so | ||
| the unzipped folder runs with nothing installed. | ||
|
|
||
| `texera_helpers/__init__.py` is generated from the helper definitions in | ||
| `common/workflow-operator`. Do not edit it by hand. After changing a helper, run | ||
|
|
||
| ``` | ||
| TEXERA_HELPERS_WRITE=1 sbt "WorkflowOperator/testOnly org.apache.texera.amber.operator.StandaloneHelpersSpec" | ||
| ``` | ||
|
|
||
| Without the variable, the same spec fails when the file is stale. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.