def test_run(self, context: Context, state: State) -> None:
"""Check running the step with score and justification."""
prescription_str = """
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: pysaml2
version: '<6.5.0'
index_url: 'https://pypi.org/simple'
run:
score: -0.1
justification:
- type: WARNING
message: CVE found for pysaml2
link: cve_pysaml2
- type: INFO
message: Package pysaml2 was removed from software stack resolution
link: https://example.com
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
package_version = PackageVersion(
name="pysaml2",
version="==6.4.0",
index=Source("https://pypi.org/simple"),
develop=False,
)
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
result = unit.run(state, package_version)
assert isinstance(result, tuple)
assert len(result) == 2
assert result[0] == -0.1
assert result[1] == unit.run_prescription["justification"]
# Run one more time to make sure justification is added only once.
result = unit.run(state, package_version)
assert isinstance(result, tuple)
assert len(result) == 2
assert result[0] == -0.1
assert result[1] is None
def test_run_develop_not_match(self, context: Context, state: State,
develop: bool) -> None:
"""Test not running the prescription if develop flag is set."""
prescription_str = f"""
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: numpy
develop: {'true' if develop else 'false'}
run:
score: 0.5
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
package_version = PackageVersion(
name="numpy",
version="==1.19.1",
index=Source("https://thoth-station.ninja/simple"),
develop=not develop,
)
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
assert unit.run(state, package_version) is None
def test_run_develop_state_match(self, context: Context, state: State,
develop: bool,
state_develop: bool) -> None:
"""Test not running the prescription if develop flag is set also on the state match."""
prescription_str = f"""
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: numpy
develop: {'true' if develop else 'false'}
state:
resolved_dependencies:
- name: pytest
develop: {'true' if state_develop else 'false'}
run:
score: 0.5
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
package_version = PackageVersion(
name="numpy",
version="==1.19.1",
index=Source("https://pypi.org/simple"),
develop=develop,
)
state_package_version = PackageVersion(
name="pytest",
version="==6.2.4",
index=Source("https://pypi.org/simple"),
develop=state_develop,
)
state.add_resolved_dependency(state_package_version.to_tuple())
context.register_package_version(state_package_version)
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
result = unit.run(state, package_version)
assert isinstance(result, tuple)
assert result[0] == 0.5
assert result[1] is None
def test_run_state_not_index_url_not_match_state(self, context: Context,
state: State) -> None:
"""Test running the prescription if state matches."""
prescription_str = """
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: numpy
version: '==1.19.1'
index_url:
not: 'https://pypi.org/simple'
state:
resolved_dependencies:
- name: tensorflow
version: '~=2.4.0'
index_url:
not: 'https://pypi.org/simple'
run:
score: 0.5
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
package_version = PackageVersion(
name="numpy",
version="==1.19.1",
index=Source("https://thoth-station.ninja/simple"),
develop=False,
)
state.add_resolved_dependency(
("tensorflow", "2.4.0",
"https://pypi.org/simple")) # This does match.
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
assert unit.run(state, package_version) is None
def test_run_package_version_from_with_other(self, context: Context,
state: State,
allow_other: bool) -> None:
"""Test running the prescription based on the dependency introduced without with considering other packages."""
prescription_str = f"""
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: numpy
state:
package_version_from_allow_other: {'true' if allow_other else 'false'}
package_version_from:
- name: scikit-learn
version: "<1.0.0"
develop: false
index_url: https://pypi.org/simple
run:
score: 0.5
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
pypi = Source("https://pypi.org/simple")
package_version = PackageVersion(
name="numpy",
version="==1.19.4",
index=pypi,
develop=False,
)
package_version_other = PackageVersion(
name="tensorflow",
version="==2.6.0",
index=pypi,
develop=False,
)
package_version_from = PackageVersion(
name="scikit-learn",
version="==0.24.2",
index=pypi,
develop=False,
)
state.add_resolved_dependency(package_version_from.to_tuple())
context.register_package_version(package_version_from)
state.add_resolved_dependency(package_version_other.to_tuple())
context.register_package_version(package_version_other)
runtime_env = context.project.runtime_environment
context.register_package_tuple(
package_version.to_tuple(),
dependent_tuple=package_version_from.to_tuple(),
develop=False,
extras=None,
os_name=runtime_env.operating_system.name,
os_version=runtime_env.operating_system.version,
python_version=runtime_env.python_version,
)
context.register_package_tuple(
package_version.to_tuple(),
dependent_tuple=package_version_other.to_tuple(),
develop=False,
extras=None,
os_name=runtime_env.operating_system.name,
os_version=runtime_env.operating_system.version,
python_version=runtime_env.python_version,
)
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
result = unit.run(state, package_version)
if allow_other:
assert isinstance(result, tuple)
assert result[0] == 0.5
assert result[1] is None
else:
assert result is None
def test_run_package_version_from_with_resolved(
self,
context: Context,
state: State,
package_version_from_version: str,
package_version_from_index: str,
package_version_from_develop: str,
resolved_version: str,
resolved_index: str,
resolved_develop: str,
add_resolved: bool,
pipeline_run: bool,
) -> None:
"""Test running the prescription based on the dependency introduced."""
prescription_str = f"""
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: numpy
state:
package_version_from:
- name: scikit-learn
version: "{package_version_from_version}"
develop: {package_version_from_develop}
index_url: {package_version_from_index}
resolved_dependencies:
- name: click
version: "{resolved_version}"
develop: {resolved_develop}
index_url: {resolved_index}
run:
score: 0.5
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
pypi = Source("https://pypi.org/simple")
package_version = PackageVersion(
name="numpy",
version="==1.19.1",
index=pypi,
develop=False,
)
package_version_from = PackageVersion(
name="scikit-learn",
version="==0.24.2",
index=pypi,
develop=False,
)
package_version_resolved = PackageVersion(
name="click",
version="==8.0.0",
index=pypi,
develop=False,
)
state.add_resolved_dependency(package_version_from.to_tuple())
context.register_package_version(package_version_from)
if add_resolved:
state.add_resolved_dependency(package_version_resolved.to_tuple())
context.register_package_version(package_version_resolved)
runtime_env = context.project.runtime_environment
context.register_package_tuple(
package_version.to_tuple(),
dependent_tuple=package_version_from.to_tuple(),
develop=False,
extras=None,
os_name=runtime_env.operating_system.name,
os_version=runtime_env.operating_system.version,
python_version=runtime_env.python_version,
)
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
result = unit.run(state, package_version)
if pipeline_run:
assert isinstance(result, tuple)
assert result[0] == 0.5
assert result[1] is None
else:
assert result is None
def test_run_state_not_index_url(self, context: Context,
state: State) -> None:
"""Test running the prescription if state matches."""
prescription_str = """
name: StepUnit
type: step
should_include:
times: 1
adviser_pipeline: true
match:
package_version:
name: numpy
version: '==1.19.1'
index_url:
not: 'https://pypi.org/simple'
state:
resolved_dependencies:
- name: tensorflow
version: '~=2.4.0'
index_url:
not: 'https://pypi.org/simple'
run:
score: 0.5
stack_info:
- type: WARNING
message: Hello, Thoth!
link: https://thoth-station.ninja
"""
prescription = yaml.safe_load(prescription_str)
PRESCRIPTION_STEP_SCHEMA(prescription)
StepPrescription.set_prescription(prescription)
package_version = PackageVersion(
name="numpy",
version="==1.19.1",
index=Source("https://thoth-station.ninja/simple"),
develop=False,
)
state.add_resolved_dependency(
("tensorflow", "2.4.0", "https://thoth-station.ninja/simple"))
unit = StepPrescription()
unit.pre_run()
with unit.assigned_context(context):
result = unit.run(state, package_version)
assert isinstance(result, tuple)
assert result[0] == 0.5
assert result[1] is None
self.verify_justification_schema(context.stack_info)
assert context.stack_info == [{
"type": "WARNING",
"message": "Hello, Thoth!",
"link": "https://thoth-station.ninja"
}]
# Run one more time to make sure stack info is added just once.
result = unit.run(state, package_version)
assert isinstance(result, tuple)
assert result[0] == 0.5
assert result[1] is None
assert context.stack_info == [{
"type": "WARNING",
"message": "Hello, Thoth!",
"link": "https://thoth-station.ninja"
}]