change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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
laurenyu merged 2 commits into from
Jul 25, 2019
Merged

change: Replaced generic ValueError with custom subclass when reporting unexpected resource status #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7d33c4
Merge pull request #1 from aws/master
arodiss Jul 25, 2019
4e768c2
change: Replaced generic ValueError with custom subclass when reporti…
arodiss Jul 10, 2019
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
23 changes: 23 additions & 0 deletions src/sagemaker/exceptions.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.

class UnexpectedStatusException(ValueError):
"""Raised when resource status is not expected and thus not allowed for further execution"""

def __init__(self, message, allowed_statuses, actual_status):
self.allowed_statuses = allowed_statuses
self.actual_status = actual_status
super(UnexpectedStatusException, self).__init__(message)
41 changes: 27 additions & 14 deletions src/sagemaker/session.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
secondary_training_status_changed,
secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

if status != "Completed":
reason = desc.get("FailureReason", None)
raise ValueError(
"Error creating model package {}: {} Reason: {}".format(
model_package_name, status, reason
)
raise exceptions.UnexpectedStatusException(
message="Error creating model package {package}: {status} Reason: {reason}".format(
package=model_package_name, status=status, reason=reason
),
allowed_statuses=["Completed"],
actual_status=status,
)
return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
(dict): Return value from the ``DescribeTrainingJob`` API.

Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
"""
desc = _wait_until_training_done(
lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
(dict): Return value from the ``DescribeCompilationJob`` API.

Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
"""
desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
(dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
"""
desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
(dict): Return value from the ``DescribeTransformJob`` API.

Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
"""
desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
self._check_job_status(job, desc, "TransformJobStatus")
return desc

def _check_job_status(self, job, desc, status_key_name):
"""Check to see if the job completed successfully and, if not, construct and
raise a ValueError.
raise a exceptions.UnexpectedStatusException.

Args:
job (str): The name of the job to check.
desc (dict[str, str]): The result of ``describe_training_job()``.
status_key_name (str): Status key name to check for.

Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
"""
status = desc[status_key_name]
# If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
if status not in ("Completed", "Stopped"):
reason = desc.get("FailureReason", "(No reason provided)")
job_type = status_key_name.replace("JobStatus", " job")
raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
raise exceptions.UnexpectedStatusException(
message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
job_type=job_type, job_name=job, status=status, reason=reason
),
allowed_statuses=["Completed", "Stopped"],
actual_status=status,
)

def wait_for_endpoint(self, endpoint, poll=5):
"""Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

if status != "InService":
reason = desc.get("FailureReason", None)
raise ValueError(
"Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
raise exceptions.UnexpectedStatusException(
message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
endpoint=endpoint, status=status, reason=reason
),
allowed_statuses=["InService"],
actual_status=status,
)
return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
completion (default: 5).

Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
"""

description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down
105 changes: 105 additions & 0 deletions tests/unit/test_exception_on_bad_status.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
boto_mock = Mock(name="boto_session", region_name=REGION)
client_mock = Mock()
client_mock.describe_model_package = MagicMock(
return_value={"ModelPackageStatus": returns_status}
)
client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
ims.expand_role = Mock(return_value=EXPANDED_ROLE)
return ims


def test_does_not_raise_when_successfully_created_package():
try:
sagemaker_session = get_sagemaker_session(returns_status="Completed")
sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
except sagemaker.exceptions.UnexpectedStatusException:
pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
try:
sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
assert (
False
), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
except Exception as e:
assert type(e) == sagemaker.exceptions.UnexpectedStatusException
assert e.actual_status == "EnRoute"
assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
try:
job = Mock()
sagemaker_session = get_sagemaker_session(returns_status="Stopped")
sagemaker_session._check_job_status(
job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
)
except sagemaker.exceptions.UnexpectedStatusException:
pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
try:
job = Mock()
sagemaker_session = get_sagemaker_session(returns_status="Failed")
sagemaker_session._check_job_status(
job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
)
assert (
False
), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
except Exception as e:
assert type(e) == sagemaker.exceptions.UnexpectedStatusException
assert e.actual_status == "Failed"
assert "Completed" in e.allowed_statuses
assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
try:
sagemaker_session = get_sagemaker_session(returns_status="InService")
sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
except sagemaker.exceptions.UnexpectedStatusException:
pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
try:
sagemaker_session = get_sagemaker_session(returns_status="Failed")
assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
assert (
False
), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
except Exception as e:
assert type(e) == sagemaker.exceptions.UnexpectedStatusException
assert e.actual_status == "Failed"
assert "InService" in e.allowed_statuses
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
change: Replaced generic ValueError with custom subclass when reporting unexpected resource status#919

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

laurenyu
merged 2 commits into

from

Jul 25, 2019
 Merged


change: Replaced generic ValueError with custom subclass when reporting unexpected resource status
#919
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
d7d33c4

Merge pull request #1 from aws/master


arodiss Jul 25, 2019
4e768c2

change: Replaced generic ValueError with custom subclass when reporti…


arodiss Jul 10, 2019

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


23 changes: 23 additions & 0 deletions
src/sagemaker/exceptions.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
"""Custom exception classes for Sagemaker SDK"""
from __future__ import absolute_import

Comment thread
laurenyu marked this conversation as resolved.


class UnexpectedStatusException(ValueError):
 """Raised when resource status is not expected and thus not allowed for further execution"""

 def __init__(self, message, allowed_statuses, actual_status):
 self.allowed_statuses = allowed_statuses
 self.actual_status = actual_status
 super(UnexpectedStatusException, self).__init__(message)

41 changes: 27 additions & 14 deletions
src/sagemaker/session.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,7 @@
 secondary_training_status_changed,
 secondary_training_status_message,
)
from sagemaker import exceptions

LOGGER = logging.getLogger("sagemaker")

Expand DownExpand Up@@ -826,10 +827,12 @@ def wait_for_model_package(self, model_package_name, poll=5):

 if status != "Completed":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error creating model package {}: {} Reason: {}".format(
 model_package_name, status, reason
 )
 raise exceptions.UnexpectedStatusException(
 message="Error creating model package {package}: {status} Reason: {reason}".format(
 package=model_package_name, status=status, reason=reason
 ),
 allowed_statuses=["Completed"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -990,7 +993,7 @@ def wait_for_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTrainingJob`` API.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 desc = _wait_until_training_done(
 lambda last_desc: _train_done(self.sagemaker_client, job, last_desc), None, poll
Expand All@@ -1009,7 +1012,7 @@ def wait_for_compilation_job(self, job, poll=5):
 (dict): Return value from the ``DescribeCompilationJob`` API.

 Raises:
ValueError: If the compilation job fails.
exceptions.UnexpectedStatusException: If the compilation job fails.
 """
 desc = _wait_until(lambda: _compilation_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "CompilationJobStatus")
Expand All@@ -1026,7 +1029,7 @@ def wait_for_tuning_job(self, job, poll=5):
 (dict): Return value from the ``DescribeHyperParameterTuningJob`` API.

 Raises:
ValueError: If the hyperparameter tuning job fails.
exceptions.UnexpectedStatusException: If the hyperparameter tuning job fails.
 """
 desc = _wait_until(lambda: _tuning_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "HyperParameterTuningJobStatus")
Expand All@@ -1043,23 +1046,23 @@ def wait_for_transform_job(self, job, poll=5):
 (dict): Return value from the ``DescribeTransformJob`` API.

 Raises:
ValueError: If the transform job fails.
exceptions.UnexpectedStatusException: If the transform job fails.
 """
 desc = _wait_until(lambda: _transform_job_status(self.sagemaker_client, job), poll)
 self._check_job_status(job, desc, "TransformJobStatus")
 return desc

 def _check_job_status(self, job, desc, status_key_name):
 """Check to see if the job completed successfully and, if not, construct and
 raise a ValueError.
 raise a exceptions.UnexpectedStatusException.

 Args:
 job (str): The name of the job to check.
 desc (dict[str, str]): The result of ``describe_training_job()``.
 status_key_name (str): Status key name to check for.

 Raises:
ValueError: If the training job fails.
exceptions.UnexpectedStatusException: If the training job fails.
 """
 status = desc[status_key_name]
 # If the status is capital case, then convert it to Camel case
Expand All@@ -1068,7 +1071,13 @@ def _check_job_status(self, job, desc, status_key_name):
 if status not in ("Completed", "Stopped"):
 reason = desc.get("FailureReason", "(No reason provided)")
 job_type = status_key_name.replace("JobStatus", " job")
 raise ValueError("Error for {} {}: {} Reason: {}".format(job_type, job, status, reason))
 raise exceptions.UnexpectedStatusException(
 message="Error for {job_type} {job_name}: {status}. Reason: {reason}".format(
 job_type=job_type, job_name=job, status=status, reason=reason
 ),
 allowed_statuses=["Completed", "Stopped"],
 actual_status=status,
 )

 def wait_for_endpoint(self, endpoint, poll=5):
 """Wait for an Amazon SageMaker endpoint deployment to complete.
Expand All@@ -1085,8 +1094,12 @@ def wait_for_endpoint(self, endpoint, poll=5):

 if status != "InService":
 reason = desc.get("FailureReason", None)
 raise ValueError(
 "Error hosting endpoint {}: {} Reason: {}".format(endpoint, status, reason)
 raise exceptions.UnexpectedStatusException(
 message="Error hosting endpoint {endpoint}: {status}. Reason: {reason}.".format(
 endpoint=endpoint, status=status, reason=reason
 ),
 allowed_statuses=["InService"],
 actual_status=status,
 )
 return desc

Expand DownExpand Up@@ -1334,7 +1347,7 @@ def logs_for_job( # noqa: C901 - suppress complexity warning for this method
 completion (default: 5).

 Raises:
ValueError: If waiting and the training job fails.
exceptions.UnexpectedStatusException: If waiting and the training job fails.
 """

 description = self.sagemaker_client.describe_training_job(TrainingJobName=job_name)
Expand Down

105 changes: 105 additions & 0 deletions
tests/unit/test_exception_on_bad_status.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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.
from __future__ import absolute_import

import pytest
from mock import Mock, MagicMock
import sagemaker

EXPANDED_ROLE = "arn:aws:iam::111111111111:role/ExpandedRole"
REGION = "us-west-2"
MODEL_PACKAGE_NAME = "my_model_package"
JOB_NAME = "my_job_name"
ENDPOINT_NAME = "the_point_of_end"


def get_sagemaker_session(returns_status):
 boto_mock = Mock(name="boto_session", region_name=REGION)
 client_mock = Mock()
 client_mock.describe_model_package = MagicMock(
 return_value={"ModelPackageStatus": returns_status}
 )
 client_mock.describe_endpoint = MagicMock(return_value={"EndpointStatus": returns_status})
 ims = sagemaker.Session(boto_session=boto_mock, sagemaker_client=client_mock)
 ims.expand_role = Mock(return_value=EXPANDED_ROLE)
 return ims


def test_does_not_raise_when_successfully_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Completed")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_created_package():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="EnRoute")
 sagemaker_session.wait_for_model_package(MODEL_PACKAGE_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "EnRoute"
 assert "Completed" in e.allowed_statuses


def test_does_not_raise_when_correct_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Stopped")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Stopped"}, "TransformationJobStatus"
 )
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_does_raise_when_incorrect_job_status():
 try:
 job = Mock()
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 sagemaker_session._check_job_status(
 job, {"TransformationJobStatus": "Failed"}, "TransformationJobStatus"
 )
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "Completed" in e.allowed_statuses
 assert "Stopped" in e.allowed_statuses


def test_does_not_raise_when_successfully_deployed_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="InService")
 sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 except sagemaker.exceptions.UnexpectedStatusException:
 pytest.fail("UnexpectedStatusException was thrown while it should not")


def test_raise_when_failed_to_deploy_endpoint():
 try:
 sagemaker_session = get_sagemaker_session(returns_status="Failed")
 assert sagemaker_session.wait_for_endpoint(ENDPOINT_NAME)
 assert (
 False
 ), "sagemaker.exceptions.UnexpectedStatusException should have been raised but was not"
 except Exception as e:
 assert type(e) == sagemaker.exceptions.UnexpectedStatusException
 assert e.actual_status == "Failed"
 assert "InService" in e.allowed_statuses