from __future__ import unicode_literals import string import boto3 import botocore.exceptions import sure # noqa import datetime import uuid import json import pkg_resources import yaml import hashlib import copy from moto.core import ACCOUNT_ID from botocore.exceptions import ClientError, ParamValidationError from nose.tools import assert_raises from moto import mock_ssm, mock_cloudformation def _get_yaml_template(): template_path = '/'.join(['test_ssm', 'test_templates', 'good.yaml']) resource_path = pkg_resources.resource_string('tests', template_path) return resource_path def _validate_document_description(doc_name, doc_description, json_doc, expected_document_version, expected_latest_version, expected_default_version, expected_format): if expected_format == "JSON": doc_description["Hash"].should.equal(hashlib.sha256(json.dumps(json_doc).encode('utf-8')).hexdigest()) else: doc_description["Hash"].should.equal(hashlib.sha256(yaml.dump(json_doc).encode('utf-8')).hexdigest()) doc_description["HashType"].should.equal("Sha256") doc_description["Name"].should.equal(doc_name) doc_description["Owner"].should.equal(ACCOUNT_ID) difference = datetime.datetime.utcnow() - doc_description["CreatedDate"] if difference.min > datetime.timedelta(minutes=1): assert False doc_description["Status"].should.equal("Active") doc_description["DocumentVersion"].should.equal(expected_document_version) doc_description["Description"].should.equal(json_doc["description"]) doc_description["Parameters"][0]["Name"].should.equal("Parameter1") doc_description["Parameters"][0]["Type"].should.equal("Integer") doc_description["Parameters"][0]["Description"].should.equal("Command Duration.") doc_description["Parameters"][0]["DefaultValue"].should.equal("3") doc_description["Parameters"][1]["Name"].should.equal("Parameter2") doc_description["Parameters"][1]["Type"].should.equal("String") doc_description["Parameters"][1]["DefaultValue"].should.equal("def") doc_description["Parameters"][2]["Name"].should.equal("Parameter3") doc_description["Parameters"][2]["Type"].should.equal("Boolean") doc_description["Parameters"][2]["Description"].should.equal("A boolean") doc_description["Parameters"][2]["DefaultValue"].should.equal("False") doc_description["Parameters"][3]["Name"].should.equal("Parameter4") doc_description["Parameters"][3]["Type"].should.equal("StringList") doc_description["Parameters"][3]["Description"].should.equal("A string list") doc_description["Parameters"][3]["DefaultValue"].should.equal("[\"abc\", \"def\"]") doc_description["Parameters"][4]["Name"].should.equal("Parameter5") doc_description["Parameters"][4]["Type"].should.equal("StringMap") doc_description["Parameters"][5]["Name"].should.equal("Parameter6") doc_description["Parameters"][5]["Type"].should.equal("MapList") if expected_format == "JSON": # We have to replace single quotes from the response to package it back up json.loads(doc_description["Parameters"][4]["DefaultValue"]).should.equal( {'NotificationArn': '$dependency.topicArn', 'NotificationEvents': ['Failed'], 'NotificationType': 'Command'}) json.loads(doc_description["Parameters"][5]["DefaultValue"]).should.equal( [{'DeviceName': '/dev/sda1', 'Ebs': {'VolumeSize': '50'}}, {'DeviceName': '/dev/sdm', 'Ebs': {'VolumeSize': '100'}}] ) else: yaml.safe_load(doc_description["Parameters"][4]["DefaultValue"]).should.equal( {'NotificationArn': '$dependency.topicArn', 'NotificationEvents': ['Failed'], 'NotificationType': 'Command'}) yaml.safe_load(doc_description["Parameters"][5]["DefaultValue"]).should.equal( [{'DeviceName': '/dev/sda1', 'Ebs': {'VolumeSize': '50'}}, {'DeviceName': '/dev/sdm', 'Ebs': {'VolumeSize': '100'}}] ) doc_description["DocumentType"].should.equal("Command") doc_description["SchemaVersion"].should.equal("2.2") doc_description["LatestVersion"].should.equal(expected_latest_version) doc_description["DefaultVersion"].should.equal(expected_default_version) doc_description["DocumentFormat"].should.equal(expected_format) # Done @mock_ssm def test_create_document(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") response = client.create_document( Content=yaml.dump(json_doc), Name="TestDocument", DocumentType="Command", DocumentFormat="YAML" ) doc_description = response["DocumentDescription"] _validate_document_description("TestDocument", doc_description, json_doc, "1", "1", "1", "YAML") response = client.create_document( Content=json.dumps(json_doc), Name="TestDocument2", DocumentType="Command", DocumentFormat="JSON" ) doc_description = response["DocumentDescription"] _validate_document_description("TestDocument2", doc_description, json_doc, "1", "1", "1", "JSON") response = client.create_document( Content=json.dumps(json_doc), Name="TestDocument3", DocumentType="Command", DocumentFormat="JSON", VersionName="Base", TargetType="/AWS::EC2::Instance", Tags=[{'Key': 'testing', 'Value': 'testingValue'}] ) doc_description = response["DocumentDescription"] doc_description["VersionName"].should.equal("Base") doc_description["TargetType"].should.equal("/AWS::EC2::Instance") doc_description["Tags"].should.equal([{'Key': 'testing', 'Value': 'testingValue'}]) _validate_document_description("TestDocument3", doc_description, json_doc, "1", "1", "1", "JSON") @mock_ssm def test_get_document(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") try: client.get_document(Name="DNE") raise RuntimeError("Should fail") except botocore.exceptions.ClientError as err: err.operation_name.should.equal("GetDocument") err.response["Error"]["Message"].should.equal("The specified document does not exist.") client.create_document( Content=yaml.dump(json_doc), Name="TestDocument3", DocumentType="Command", DocumentFormat="YAML", VersionName="Base" ) response = client.get_document(Name="TestDocument3") response["Name"].should.equal("TestDocument3") response["VersionName"].should.equal("Base") response["DocumentVersion"].should.equal("1") response["Status"].should.equal("Active") response["Content"].should.equal(yaml.dump(json_doc)) response["DocumentType"].should.equal("Command") response["DocumentFormat"].should.equal("YAML") response = client.get_document(Name="TestDocument3", DocumentFormat="YAML") response["Name"].should.equal("TestDocument3") response["VersionName"].should.equal("Base") response["DocumentVersion"].should.equal("1") response["Status"].should.equal("Active") response["Content"].should.equal(yaml.dump(json_doc)) response["DocumentType"].should.equal("Command") response["DocumentFormat"].should.equal("YAML") response = client.get_document(Name="TestDocument3", DocumentFormat="JSON") response["Name"].should.equal("TestDocument3") response["VersionName"].should.equal("Base") response["DocumentVersion"].should.equal("1") response["Status"].should.equal("Active") response["Content"].should.equal(json.dumps(json_doc)) response["DocumentType"].should.equal("Command") response["DocumentFormat"].should.equal("JSON") # response = client.get_document(Name="TestDocument3", VersionName="Base") # response = client.get_document(Name="TestDocument3", DocumentVersion="1") # response = client.get_document(Name="TestDocument3", DocumentVersion="2") # response = client.get_document(Name="TestDocument3", VersionName="Base", DocumentVersion="2") # response = client.get_document(Name="TestDocument3", DocumentFormat="YAML") # response = client.get_document(Name="TestDocument3", DocumentFormat="JSON") @mock_ssm def test_delete_document(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") # Test simple client.create_document( Content=yaml.dump(json_doc), Name="TestDocument3", DocumentType="Command", DocumentFormat="YAML", VersionName="Base", TargetType="/AWS::EC2::Instance" ) response = client.delete_document(Name="TestDocument3") # response = client.get_document(Name="TestDocument3") # # # Test re-use # client.create_document( # Content=yaml.dump(json_doc), Name="TestDocument3", DocumentType="Command", DocumentFormat="YAML", # VersionName="Base", TargetType="/AWS::EC2::Instance" # ) # response = client.get_document(Name="TestDocument3") # updates # We update default_version here to test some other cases around deleting specific versions # response = client.update_document_default_version( # Name="TestDocument3", # DocumentVersion=2 # ) # # response = client.delete_document(Name="TestDocument3", DocumentVersion="4") # response = client.get_document(Name="TestDocument3") # response = client.get_document(Name="TestDocument3", DocumentVersion="4") # # # Both filters should match in order to delete # response = client.delete_document(Name="TestDocument3", DocumentVersion="1", VersionName="NotVersion") # response = client.get_document(Name="TestDocument3") # response = client.get_document(Name="TestDocument3", DocumentVersion="1") # # response = client.delete_document(Name="TestDocument3", DocumentVersion="1", VersionName="RealVersion") # response = client.get_document(Name="TestDocument3") # response = client.get_document(Name="TestDocument3", DocumentVersion="1") # # # AWS doesn't allow deletion of default version if other versions are left # response = client.delete_document(Name="TestDocument3", DocumentVersion="2") # # response = client.delete_document(Name="TestDocument3") # response = client.get_document(Name="TestDocument3") # response = client.get_document(Name="TestDocument3", DocumentVersion="3") # Done @mock_ssm def test_update_document_default_version(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") try: client.update_document_default_version(Name="DNE", DocumentVersion="1") raise RuntimeError("Should fail") except botocore.exceptions.ClientError as err: err.operation_name.should.equal("UpdateDocumentDefaultVersion") err.response["Error"]["Message"].should.equal("The specified document does not exist.") client.create_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentType="Command", VersionName="Base" ) json_doc['description'] = "a new description" client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="$LATEST", DocumentFormat="JSON" ) json_doc['description'] = "a new description2" client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="$LATEST" ) response = client.update_document_default_version( Name="TestDocument", DocumentVersion="2" ) response["Description"]["Name"].should.equal("TestDocument") response["Description"]["DefaultVersion"].should.equal("2") json_doc['description'] = "a new description3" client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="$LATEST", VersionName="NewBase" ) response = client.update_document_default_version( Name="TestDocument", DocumentVersion="4" ) response["Description"]["Name"].should.equal("TestDocument") response["Description"]["DefaultVersion"].should.equal("4") response["Description"]["DefaultVersionName"].should.equal("NewBase") # Done @mock_ssm def test_update_document(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") try: client.update_document(Name="DNE", Content=json.dumps(json_doc), DocumentVersion="1", DocumentFormat="JSON") raise RuntimeError("Should fail") except botocore.exceptions.ClientError as err: err.operation_name.should.equal("UpdateDocument") err.response["Error"]["Message"].should.equal("The specified document does not exist.") client.create_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentType="Command", DocumentFormat="JSON", VersionName="Base" ) # Duplicate content throws an error try: client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="1", DocumentFormat="JSON" ) raise RuntimeError("Should fail") except botocore.exceptions.ClientError as err: err.operation_name.should.equal("UpdateDocument") err.response["Error"]["Message"].should.equal("The content of the association document matches another " "document. Change the content of the document and try again.") json_doc['description'] = "a new description" # Duplicate version name try: client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="1", DocumentFormat="JSON", VersionName="Base" ) raise RuntimeError("Should fail") except botocore.exceptions.ClientError as err: err.operation_name.should.equal("UpdateDocument") err.response["Error"]["Message"].should.equal("The specified version name is a duplicate.") response = client.update_document( Content=json.dumps(json_doc), Name="TestDocument", VersionName="Base2", DocumentVersion="1", DocumentFormat="JSON" ) response["DocumentDescription"]["Description"].should.equal("a new description") response["DocumentDescription"]["DocumentVersion"].should.equal("2") response["DocumentDescription"]["LatestVersion"].should.equal("2") response["DocumentDescription"]["DefaultVersion"].should.equal("1") json_doc['description'] = "a new description2" response = client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="$LATEST", DocumentFormat="JSON", VersionName="NewBase" ) response["DocumentDescription"]["Description"].should.equal("a new description2") response["DocumentDescription"]["DocumentVersion"].should.equal("3") response["DocumentDescription"]["LatestVersion"].should.equal("3") response["DocumentDescription"]["DefaultVersion"].should.equal("1") response["DocumentDescription"]["VersionName"].should.equal("NewBase") # Done @mock_ssm def test_describe_document(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") try: client.describe_document(Name="DNE") raise RuntimeError("Should fail") except botocore.exceptions.ClientError as err: err.operation_name.should.equal("DescribeDocument") err.response["Error"]["Message"].should.equal("The specified document does not exist.") client.create_document( Content=yaml.dump(json_doc), Name="TestDocument", DocumentType="Command", DocumentFormat="YAML", VersionName="Base", TargetType="/AWS::EC2::Instance", Tags=[{'Key': 'testing', 'Value': 'testingValue'}] ) response = client.describe_document(Name="TestDocument") doc_description=response['Document'] _validate_document_description("TestDocument", doc_description, json_doc, "1", "1", "1", "YAML") # Adding update to check for issues new_json_doc = copy.copy(json_doc) new_json_doc['description'] = "a new description2" client.update_document( Content=json.dumps(new_json_doc), Name="TestDocument", DocumentVersion="$LATEST" ) response = client.describe_document(Name="TestDocument") doc_description = response['Document'] _validate_document_description("TestDocument", doc_description, json_doc, "1", "2", "1", "YAML") # Done @mock_ssm def test_list_documents(): template_file = _get_yaml_template() json_doc = yaml.safe_load(template_file) client = boto3.client("ssm", region_name="us-east-1") client.create_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentType="Command", DocumentFormat="JSON" ) client.create_document( Content=json.dumps(json_doc), Name="TestDocument2", DocumentType="Command", DocumentFormat="JSON" ) client.create_document( Content=json.dumps(json_doc), Name="TestDocument3", DocumentType="Command", DocumentFormat="JSON" ) response = client.list_documents() len(response['DocumentIdentifiers']).should.equal(3) response['DocumentIdentifiers'][0]["Name"].should.equal("TestDocument") response['DocumentIdentifiers'][1]["Name"].should.equal("TestDocument2") response['DocumentIdentifiers'][2]["Name"].should.equal("TestDocument3") response['NextToken'].should.equal("") response = client.list_documents(MaxResults=1) len(response['DocumentIdentifiers']).should.equal(1) response['DocumentIdentifiers'][0]["Name"].should.equal("TestDocument") response['DocumentIdentifiers'][0]["DocumentVersion"].should.equal("1") response['NextToken'].should.equal("1") response = client.list_documents(MaxResults=1, NextToken=response['NextToken']) len(response['DocumentIdentifiers']).should.equal(1) response['DocumentIdentifiers'][0]["Name"].should.equal("TestDocument2") response['DocumentIdentifiers'][0]["DocumentVersion"].should.equal("1") response['NextToken'].should.equal("2") response = client.list_documents(MaxResults=1, NextToken=response['NextToken']) len(response['DocumentIdentifiers']).should.equal(1) response['DocumentIdentifiers'][0]["Name"].should.equal("TestDocument3") response['DocumentIdentifiers'][0]["DocumentVersion"].should.equal("1") response['NextToken'].should.equal("") # making sure no bad interactions with update json_doc['description'] = "a new description" client.update_document( Content=json.dumps(json_doc), Name="TestDocument", DocumentVersion="$LATEST", DocumentFormat="JSON" ) client.update_document( Content=json.dumps(json_doc), Name="TestDocument2", DocumentVersion="$LATEST", DocumentFormat="JSON" ) response = client.update_document_default_version( Name="TestDocument", DocumentVersion="2" ) response = client.list_documents() len(response['DocumentIdentifiers']).should.equal(3) response['DocumentIdentifiers'][0]["Name"].should.equal("TestDocument") response['DocumentIdentifiers'][0]["DocumentVersion"].should.equal("2") response['DocumentIdentifiers'][1]["Name"].should.equal("TestDocument2") response['DocumentIdentifiers'][1]["DocumentVersion"].should.equal("1") response['DocumentIdentifiers'][2]["Name"].should.equal("TestDocument3") response['DocumentIdentifiers'][2]["DocumentVersion"].should.equal("1") response['NextToken'].should.equal("")