iotedgedev 3.3.4__zip

s/tests/assets/test_solution_shared_lib/sample_module_2/module.json

@@ -0,0 +1,18 @@
+{
+    "$schema-version": "0.0.1",
+    "description": "",
+    "image": {
+        "repository": "${CONTAINER_REGISTRY_SERVER}/sample_module_2",
+        "tag": {
+            "version": "0.0.1-RC",
+            "platforms": {
+                "amd64": "./Dockerfile.amd64",
+                "amd64.debug": "./Dockerfile.amd64.debug",
+                "windows-amd64": "./Dockerfile.windows-amd64"
+            }
+        },
+        "buildOptions": [],
+        "contextPath": "../"
+    },
+    "language": "csharp"
+}

s/tests/assets/test_solution_shared_lib/sample_module_2/sample_module_2.csproj

@@ -0,0 +1,26 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp2.1</TargetFramework>
+  </PropertyGroup>
+  
+  <PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|netcoreapp2.1|AnyCPU'">
+    <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
+    <TreatSpecificWarningsAsErrors />
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Azure.Devices.Client" Version="1.40.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="2.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="2.0.0" />
+    <PackageReference Include="System.Runtime.Loader" Version="4.3.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\libs\sharedlib\sharedlib.csproj" />
+  </ItemGroup>
+</Project>

s/tests/test_azurecli.py

@@ -0,0 +1,33 @@
+import pytest
+
+from iotedgedev.azurecli import get_query_argument_for_id_and_name
+
+pytestmark = pytest.mark.unit
+
+
+def get_terms(query):
+    # These tests are all asserting that the query contains two terms enclosed in
+    # [?], separated by ||
+    # They don't care about the order. Tests will fail if the square brackets and ||
+    # contract is violated, but we'd want them to fail in that case.
+    return query[2:len(query)-1].split(" || ")
+
+
+def test_lowercase_token_should_be_lowercase_for_name_and_id():
+    token = "abc123"
+    query = get_query_argument_for_id_and_name(token)
+    terms = get_terms(query)
+
+    assert len(terms) == 2
+    assert "starts_with(@.id,'abc123')" in terms
+    assert "contains(@.name,'abc123')" in terms
+
+
+def test_mixedcase_token_should_be_lowercase_for_id_but_unmodified_for_name():
+    token = "AbC123"
+    query = get_query_argument_for_id_and_name(token)
+    terms = get_terms(query)
+
+    assert len(terms) == 2
+    assert "starts_with(@.id,'abc123')" in terms
+    assert "contains(@.name,'AbC123')" in terms

s/tests/test_buildoptionsparser.py

@@ -0,0 +1,155 @@
+import pytest
+from iotedgedev.buildoptionsparser import BuildOptionsParser
+
+pytestmark = pytest.mark.unit
+
+
+def test_filter_build_options():
+    build_options = [
+        "--rm",
+        "-f test",
+        "--file test",
+        "-t image",
+        "--tag image"
+    ]
+    build_options_parser = BuildOptionsParser(build_options)
+    assert not build_options_parser.parse_build_options()
+
+
+def test_parse_to_dict():
+    build_options = [
+        "--add-host=github.com:192.30.255.112",
+        "--add-host=ports.ubuntu.com:91.189.88.150",
+        "--build-arg a=b",
+        "--build-arg c=d",
+        "--label e=f",
+        "--label g"
+    ]
+    sdk_options = {
+        'extra_hosts': {
+            'github.com': '192.30.255.112',
+            'ports.ubuntu.com': '91.189.88.150'
+        },
+        'buildargs': {
+            'a': 'b',
+            'c': 'd'
+        },
+        'labels': {
+            'e': 'f',
+            'g': ''
+        }
+    }
+    build_options_parser = BuildOptionsParser(build_options)
+    assert sdk_options == build_options_parser.parse_build_options()
+
+
+def test_parse_to_list():
+    build_options = [
+        "--cache-from a",
+        "--cache-from b"
+    ]
+    sdk_options = {
+        'cache_from': ['a', 'b']
+    }
+    build_options_parser = BuildOptionsParser(build_options)
+    assert sdk_options == build_options_parser.parse_build_options()
+
+
+def test_parse_val():
+    build_options = [
+        "--network bridge",
+        "--platform Linux",
+        "--shm-size 1000000",
+        "--target target"
+    ]
+    sdk_options = {
+        'network_mode': 'bridge',
+        'platform': 'Linux',
+        'shmsize': '1000000',
+        'target': 'target'
+    }
+    build_options_parser = BuildOptionsParser(build_options)
+    assert sdk_options == build_options_parser.parse_build_options()
+
+
+def test_parse_container_limits():
+    build_options = [
+        "--cpu-shares 50",
+        "--cpuset-cpus 0-1",
+        "--memory 10000000",
+        "--memory-swap 2000000"
+    ]
+    sdk_options = {
+        'container_limits': {
+            'cpushares': '50',
+            'cpusetcpus': '0-1',
+            'memory': '10000000',
+            'memswap': '2000000'
+        }
+    }
+    build_options_parser = BuildOptionsParser(build_options)
+    assert sdk_options == build_options_parser.parse_build_options()
+
+
+def test_parse_flag():
+    build_options = [
+        "--pull=true",
+        "-q=false",
+        "--no-cache"
+    ]
+    sdk_options = {
+        'pull': True,
+        'quiet': False,
+        'nocache': True
+    }
+    build_options_parser = BuildOptionsParser(build_options)
+    assert sdk_options == build_options_parser.parse_build_options()
+
+
+def test_invalid_build_options():
+    with pytest.raises(KeyError):
+        build_options = [
+            "--cgroup-parent",
+            "--compress",
+            "--cpu-period",
+            "--cpuset-mems 10",
+        ]
+        build_options_parser = BuildOptionsParser(build_options)
+        build_options_parser.parse_build_options()
+
+
+def test_filtered_valid_build_options():
+    build_options = [
+        "--rm",
+        "--file test",
+        "--tag image",
+        "--add-host=github.com:192.30.255.112",
+        "--add-host=ports.ubuntu.com:91.189.88.150",
+        "--cache-from a",
+        "--cache-from b",
+        "--network bridge",
+        "--platform Linux",
+        "--cpu-shares 50",
+        "--memory 10000000",
+        "--pull=true",
+        "-q=false",
+        "--no-cache"
+    ]
+    sdk_options = {
+        'extra_hosts': {
+            'github.com': '192.30.255.112',
+            'ports.ubuntu.com': '91.189.88.150'
+        },
+        'cache_from': ['a', 'b'],
+        'network_mode': 'bridge',
+        'platform': 'Linux',
+        'container_limits': {
+            'cpushares': '50',
+            'memory': '10000000',
+        },
+        'pull': True,
+        'quiet': False,
+        'nocache': True
+    }
+    build_options_parser = BuildOptionsParser(build_options)
+    assert sdk_options == build_options_parser.parse_build_options()

s/tests/test_cli.py

@@ -0,0 +1,55 @@
+from iotedgedev.cli import main
+from .utility import get_cli_command_structure
+import pytest
+
+pytestmark = pytest.mark.unit
+
+
+def test_cli_structure():
+    # Arrange
+    expected_structure = {
+        "solution": {
+            "new": None,
+            "init": None,
+            "e2e": None,
+            "add": None,
+            "build": None,
+            "push": None,
+            "deploy": None,
+            "tag": None,
+            "genconfig": None
+        },
+        "simulator": {
+            "setup": None,
+            "start": None,
+            "stop": None,
+            "modulecred": None
+        },
+        "iothub": {
+            "deploy": None,
+            "monitor": None,
+            "setup": None
+        },
+        "docker": {
+            "setup": None,
+            "clean": None,
+            "log": None
+        },
+        "new": None,
+        "init": None,
+        "add": None,
+        "build": None,
+        "push": None,
+        "deploy": None,
+        "genconfig": None,
+        "setup": None,
+        "start": None,
+        "stop": None,
+        "monitor": None,
+        "log": None
+    }
+    # Act
+    structure = get_cli_command_structure(main)
+
+    # Assert
+    assert structure == expected_structure

s/tests/test_config.py

@@ -0,0 +1,28 @@
+import os
+
+import pytest
+
+from iotedgedev.telemetryconfig import TelemetryConfig
+
+pytestmark = pytest.mark.unit
+
+
+def test_firsttime(request):
+    config = TelemetryConfig()
+
+    def clean():
+        config_path = config.get_config_path()
+        if os.path.exists(config_path):
+            os.remove(config_path)
+    request.addfinalizer(clean)
+
+    clean()
+    config = TelemetryConfig()
+
+    assert config.get(config.DEFAULT_DIRECT, config.FIRSTTIME_SECTION) == 'yes'
+    assert config.get(config.DEFAULT_DIRECT, config.TELEMETRY_SECTION) is None
+
+    config.check_firsttime()
+
+    assert config.get(config.DEFAULT_DIRECT, config.FIRSTTIME_SECTION) == 'no'
+    assert config.get(config.DEFAULT_DIRECT, config.TELEMETRY_SECTION) == 'yes'

s/tests/test_connectionstring.py

@@ -0,0 +1,87 @@
+import pytest
+
+from iotedgedev.connectionstring import (ConnectionString,
+                                         DeviceConnectionString,
+                                         IoTHubConnectionString)
+
+pytestmark = pytest.mark.unit
+
+emptystring = ""
+valid_connectionstring = "HostName=testhub.azure-devices.net;SharedAccessKey=gibberish"
+valid_iothub_connectionstring = "HostName=ChaoyiTestIoT.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=moregibberish"
+valid_device_connectionstring = "HostName=testhub.azure-devices.net;DeviceId=testdevice;SharedAccessKey=othergibberish"
+invalid_connectionstring = "HostName=azure-devices.net;SharedAccessKey=gibberish"
+invalid_iothub_connectionstring = "HostName=testhub.azure-devices.net;SharedAccessKey=moregibberish"
+invalid_device_connectionstring = "HostName=testhub.azure-devices.net;DeviceId=;SharedAccessKey=othergibberish"
+empty_hostname_iothub_connectionstring = "HostName=;SharedAccessKeyName=iothubowner;SharedAccessKey=moregibberish"
+non_sas_connectionstring = "HostName=testhub.azure-devices.net;DeviceId=testdevice;x509=true"
+
+
+def test_non_sas_connectionstring():
+    connStr = ConnectionString(non_sas_connectionstring)
+    assert not connStr.connection_string
+
+
+def test_empty_connectionstring():
+    connectionstring = ConnectionString(emptystring)
+    assert not connectionstring.data
+
+
+def test_empty_hostname_iothub_connectionstring():
+    connectionstring = ConnectionString(empty_hostname_iothub_connectionstring)
+    assert connectionstring.iothub_host.name == ""
+    assert connectionstring.iothub_host.hub_name == ""
+    assert connectionstring.shared_access_key == "moregibberish"
+    assert connectionstring.iothub_host.name_hash == ""
+
+
+def test_empty_iothub_connectionstring():
+    connectionstring = IoTHubConnectionString(emptystring)
+    assert not connectionstring.data
+
+
+def test_empty_device_connectionstring():
+    connectionstring = DeviceConnectionString(emptystring)
+    assert not connectionstring.data
+
+
+def test_valid_connectionstring():
+    connectionstring = ConnectionString(valid_connectionstring)
+    assert connectionstring.iothub_host.name == "testhub.azure-devices.net"
+    assert connectionstring.iothub_host.hub_name == "testhub"
+    assert connectionstring.shared_access_key == "gibberish"
+
+
+def test_valid_iothub_connectionstring():
+    connectionstring = IoTHubConnectionString(valid_iothub_connectionstring)
+    assert connectionstring.iothub_host.name == "ChaoyiTestIoT.azure-devices.net"
+    assert connectionstring.iothub_host.hub_name == "ChaoyiTestIoT"
+    assert connectionstring.shared_access_key_name == "iothubowner"
+    assert connectionstring.shared_access_key == "moregibberish"
+    assert connectionstring.iothub_host.name_hash == "6b8fcfea09003d5f104771e83bd9ff54c592ec2277ec1815df91dd64d1633778"
+
+
+def test_valid_devicehub_connectionstring():
+    connectionstring = DeviceConnectionString(valid_device_connectionstring)
+    assert connectionstring.iothub_host.name == "testhub.azure-devices.net"
+    assert connectionstring.iothub_host.hub_name == "testhub"
+    assert connectionstring.device_id == "testdevice"
+    assert connectionstring.shared_access_key == "othergibberish"
+
+
+def test_invalid_connectionstring():
+    connectionstring = ConnectionString(invalid_connectionstring)
+    assert connectionstring.iothub_host.hub_name != "testhub"
+
+
+def test_invalid_iothub_connectionstring():
+    with pytest.raises(KeyError):
+        IoTHubConnectionString(invalid_iothub_connectionstring)
+
+
+def test_invalid_devicehub_connectionstring():
+    connectionstring = DeviceConnectionString(invalid_device_connectionstring)
+    assert connectionstring.iothub_host.name == "testhub.azure-devices.net"
+    assert connectionstring.iothub_host.hub_name == "testhub"
+    assert not connectionstring.device_id
+    assert connectionstring.shared_access_key == "othergibberish"

s/tests/test_decorators.py

@@ -0,0 +1,44 @@
+import hashlib
+
+import pytest
+
+from iotedgedev.decorators import hash256_result, suppress_all_exceptions
+
+pytestmark = pytest.mark.unit
+
+
+def test_suppress_all_exceptions():
+    @suppress_all_exceptions()
+    def test_valid():
+        return 'Everything is OK'
+    assert test_valid() == 'Everything is OK'
+
+    @suppress_all_exceptions('fallback')
+    def test_exception_fallback():
+        raise Exception
+    assert test_exception_fallback() == 'fallback'
+
+    @suppress_all_exceptions()
+    def test_exception_nofallback():
+        raise Exception
+    assert not test_exception_nofallback()
+
+
+def test_hash256_result():
+    @hash256_result
+    def test_valid():
+        return "test"
+    expect_hash = hashlib.sha256("test".encode('utf-8'))
+    assert str(expect_hash.hexdigest()) == test_valid()
+
+    @hash256_result
+    def test_none():
+        return None
+    with pytest.raises(ValueError):
+        test_none()
+
+    @hash256_result
+    def test_nostring():
+        return 0
+    with pytest.raises(ValueError):
+        test_nostring()

s/tests/test_deploymentmanifest.py

@@ -0,0 +1,106 @@
+import json
+import os
+
+import pytest
+
+from iotedgedev.deploymentmanifest import DeploymentManifest
+from iotedgedev.envvars import EnvVars
+from iotedgedev.output import Output
+from iotedgedev.utility import Utility
+
+from .utility import assert_list_equal
+
+pytestmark = pytest.mark.unit
+
+tests_dir = os.path.join(os.getcwd(), "tests")
+test_assets_dir = os.path.join(tests_dir, "assets")
+test_file_1 = os.path.join(test_assets_dir, "deployment.template_1.json")
+test_file_2 = os.path.join(test_assets_dir, "deployment.template_2.json")
+test_file_3 = os.path.join(test_assets_dir, "deployment.template_3.json")
+
+
+@pytest.fixture
+def deployment_manifest():
+    output = Output()
+    envvars = EnvVars(output)
+    envvars.load()
+    utility = Utility(envvars, output)
+
+    def _deployment_manifest(path):
+        return DeploymentManifest(envvars, output, utility, path, True)
+
+    return _deployment_manifest
+
+
+def test_get_desired_property(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    props = deployment_manifest.get_desired_property("$edgeHub", "schemaVersion")
+    assert props == deployment_manifest.envvars.EDGEHUB_SCHEMA_VERSION
+
+
+def test_get_desired_property_nonexistent_module(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    with pytest.raises(KeyError):
+        deployment_manifest.get_desired_property("nonexistentModule", "schemaVersion")
+
+
+def test_get_desired_property_nonexistent_prop(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    with pytest.raises(KeyError):
+        deployment_manifest.get_desired_property("$edgeHub", "nonexistentProp")
+
+
+def test_get_user_modules(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    user_modules = list(deployment_manifest.get_user_modules().keys())
+    assert_list_equal(user_modules, ["tempSensor", "csharpmodule", "csharpfunction"])
+
+
+def test_get_system_modules(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    system_modules = list(deployment_manifest.get_system_modules().keys())
+    assert_list_equal(system_modules, ["edgeAgent", "edgeHub"])
+
+
+def test_get_all_modules(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    system_modules = list(deployment_manifest.get_all_modules().keys())
+    assert_list_equal(system_modules, ["edgeAgent", "edgeHub", "tempSensor", "csharpmodule", "csharpfunction"])
+
+
+def test_add_module_template(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    deployment_manifest.add_module_template("csharpmodule2")
+    expected = json.loads(Utility.get_file_contents(test_file_3, expandvars=True))
+    assert deployment_manifest.json == expected
+
+
+def test_convert_create_options(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+
+    temp_sensor_settings = deployment_manifest.json["modulesContent"]["$edgeAgent"]["properties.desired"]["modules"]["tempSensor"]["settings"]
+    temp_sensor_create_options_copy = json.loads(json.dumps(temp_sensor_settings["createOptions"]))
+
+    deployment_manifest.convert_create_options()
+    assert deployment_manifest.json["modulesContent"]["$edgeAgent"]["properties.desired"]["systemModules"]["edgeAgent"]["settings"][
+        "createOptions"] == ""
+    assert json.loads(deployment_manifest.json["modulesContent"]["$edgeAgent"]["properties.desired"]["systemModules"]["edgeHub"]["settings"][
+        "createOptions"]) == json.loads("{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}")
+
+    assert "createOptions" in temp_sensor_settings
+    assert "createOptions01" in temp_sensor_settings
+    assert "createOptions02" in temp_sensor_settings
+
+    create_options_str = temp_sensor_settings["createOptions"] + temp_sensor_settings["createOptions01"] + temp_sensor_settings["createOptions02"]
+    assert json.loads(create_options_str) == temp_sensor_create_options_copy
+
+
+def test_expand_image_placeholders(deployment_manifest):
+    deployment_manifest = deployment_manifest(test_file_1)
+    deployment_manifest.expand_image_placeholders({"csharpmodule": "localhost:5000/csharpmodule:0.0.1-amd64"})
+    assert deployment_manifest.json["modulesContent"]["$edgeAgent"]["properties.desired"]["modules"]["csharpmodule"]["settings"]["image"] == "localhost:5000/csharpmodule:0.0.1-amd64"
+
+
+def test_get_image_placeholder():
+    assert DeploymentManifest.get_image_placeholder("filtermodule") == "${MODULES.filtermodule}"
+    assert DeploymentManifest.get_image_placeholder("filtermodule", True) == "${MODULES.filtermodule.debug}"