test_update.py

# This file is part of arduino-cli.
#
# Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
#
# This software is released under the GNU General Public License version 3,
# which covers the main part of arduino-cli.
# The terms of this license can be found at:
# https://www.gnu.org/licenses/gpl-3.0.en.html
#
# You can be released from the requirements of the above licenses by purchasing
# a commercial license. Buying such a license is mandatory if you want to modify or
# otherwise use the software for commercial activities involving the Arduino
# software without disclosing the source code of your own applications. To purchase
# a commercial license, send an email to license@arduino.cc.

from pathlib import Path


def test_update(run_command):
    res = run_command(["update"])
    assert res.ok
    lines = [l.strip() for l in res.stdout.splitlines()]

    assert "Downloading index: package_index.json downloaded" in lines
    assert "Downloading index signature: package_index.json.sig downloaded" in lines
    assert "Downloading index: library_index.json.gz downloaded" in lines
    assert "Downloading index signature: library_index.json.sig downloaded" in lines


def test_update_showing_outdated(run_command):
    # Updates index for cores and libraries
    run_command(["core", "update-index"])
    run_command(["lib", "update-index"])

    # Installs an outdated core and library
    run_command(["core", "install", "arduino:avr@1.6.3"])
    assert run_command(["lib", "install", "USBHost@1.0.0"])

    # Installs latest version of a core and a library
    run_command(["core", "install", "arduino:samd"])
    assert run_command(["lib", "install", "ArduinoJson"])

    # Verifies outdated cores and libraries are printed after updating indexes
    result = run_command(["update", "--show-outdated"])
    assert result.ok
    lines = [l.strip() for l in result.stdout.splitlines()]

    assert "Downloading index: package_index.json downloaded" in lines
    assert "Downloading index signature: package_index.json.sig downloaded" in lines
    assert "Downloading index: library_index.json.gz downloaded" in lines
    assert "Downloading index signature: library_index.json.sig downloaded" in lines
    assert lines[-5].startswith("Arduino AVR Boards")
    assert lines[-2].startswith("USBHost")


def test_update_with_url_not_found(run_command, httpserver):
    assert run_command(["update"])

    # Brings up a local server to fake a failure
    httpserver.expect_request("/test_index.json").respond_with_data(status=404)
    url = httpserver.url_for("/test_index.json")

    res = run_command(["update", f"--additional-urls={url}"])
    assert res.failed
    lines = [l.strip() for l in res.stderr.splitlines()]
    assert (
        f"Error updating core and libraries index: Error downloading index '{url}':"
        " Server responded with: 404 NOT FOUND" in lines
    )


def test_update_with_url_internal_server_error(run_command, httpserver):
    assert run_command(["update"])

    # Brings up a local server to fake a failure
    httpserver.expect_request("/test_index.json").respond_with_data(status=500)
    url = httpserver.url_for("/test_index.json")

    res = run_command(["update", f"--additional-urls={url}"])
    assert res.failed
    lines = [l.strip() for l in res.stderr.splitlines()]
    assert (
        f"Error updating core and libraries index: Error downloading index '{url}':"
        " Server responded with: 500 INTERNAL SERVER ERROR" in lines
    )


def test_update_showing_outdated_using_library_with_invalid_version(run_command, data_dir):
    assert run_command(["update"])

    # Install latest version of a library
    assert run_command(["lib", "install", "WiFi101"])

    # Verifies library doesn't get updated
    res = run_command(["update", "--show-outdated"])
    assert res.ok
    assert "WiFi101" not in res.stdout

    # Changes the version of the currently installed library so that it's
    # invalid
    lib_path = Path(data_dir, "libraries", "WiFi101")
    Path(lib_path, "library.properties").write_text("name=WiFi101\nversion=1.0001")

    # Verifies library gets updated
    res = run_command(["update", "--show-outdated"])
    assert res.ok
    assert "WiFi101" in res.stdout