Migrate TestCoreSearchSortedResults from test_core.py to core_test.go

Author: MatteoPologruto

internal/integrationtest/core/core_test.go

@@ -18,6 +18,7 @@ package core_test
 import (
 	"fmt"
 	"runtime"
+	"sort"
 	"strconv"
 	"strings"
 	"testing"
@@ -582,3 +583,75 @@ func TestCoreListWithInstalledJson(t *testing.T) {
 		}
 	]`)
 }
+
+func TestCoreSearchSortedResults(t *testing.T) {
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	// Set up the server to serve our custom index file
+	testIndex := paths.New("..", "testdata", "test_index.json")
+	url := env.HTTPServeFile(8000, testIndex)
+
+	// update custom index
+	_, _, err := cli.Run("core", "update-index", "--additional-urls="+url.String())
+	require.NoError(t, err)
+
+	// This is done only to avoid index update output when calling core search
+	// since it automatically updates them if they're outdated and it makes it
+	// harder to parse the list of cores
+	_, _, err = cli.Run("core", "search")
+	require.NoError(t, err)
+
+	// list all with additional url specified
+	stdout, _, err := cli.Run("core", "search", "--additional-urls="+url.String())
+	require.NoError(t, err)
+
+	out := strings.Split(strings.TrimSpace(string(stdout)), "\n")
+	var lines, deprecated, notDeprecated [][]string
+	for i, v := range out {
+		if i > 0 {
+			v = strings.Join(strings.Fields(v), " ")
+			lines = append(lines, strings.SplitN(v, " ", 3))
+		}
+	}
+	for _, v := range lines {
+		if strings.HasPrefix(v[2], "[DEPRECATED]") {
+			deprecated = append(deprecated, v)
+		} else {
+			notDeprecated = append(notDeprecated, v)
+		}
+	}
+
+	// verify that results are already sorted correctly
+	require.True(t, sort.SliceIsSorted(deprecated, func(i, j int) bool {
+		return strings.ToLower(deprecated[i][2]) < strings.ToLower(deprecated[j][2])
+	}))
+	require.True(t, sort.SliceIsSorted(notDeprecated, func(i, j int) bool {
+		return strings.ToLower(notDeprecated[i][2]) < strings.ToLower(notDeprecated[j][2])
+	}))
+
+	// verify that deprecated platforms are the last ones
+	require.Equal(t, lines, append(notDeprecated, deprecated...))
+
+	// test same behaviour with json output
+	stdout, _, err = cli.Run("core", "search", "--additional-urls="+url.String(), "--format=json")
+	require.NoError(t, err)
+
+	// verify that results are already sorted correctly
+	sortedDeprecated := requirejson.Parse(t, stdout).Query(
+		"[ .[] | select(.deprecated == true) | .name |=ascii_downcase | .name ] | sort").String()
+	notSortedDeprecated := requirejson.Parse(t, stdout).Query(
+		"[.[] | select(.deprecated == true) | .name |=ascii_downcase | .name]").String()
+	require.Equal(t, sortedDeprecated, notSortedDeprecated)
+
+	sortedNotDeprecated := requirejson.Parse(t, stdout).Query(
+		"[ .[] | select(.deprecated != true) | .name |=ascii_downcase | .name ] | sort").String()
+	notSortedNotDeprecated := requirejson.Parse(t, stdout).Query(
+		"[.[] | select(.deprecated != true) | .name |=ascii_downcase | .name]").String()
+	require.Equal(t, sortedNotDeprecated, notSortedNotDeprecated)
+
+	// verify that deprecated platforms are the last ones
+	platform := requirejson.Parse(t, stdout).Query(
+		"[.[] | .name |=ascii_downcase | .name]").String()
+	require.True(t, strings.HasSuffix(platform, strings.TrimLeft(notSortedDeprecated, "[")))
+}

test/test_core.py

@@ -93,50 +93,6 @@ def test_core_search_update_index_delay(run_command, data_dir):
     assert "Downloading index" not in res.stdout
 
 
-def test_core_search_sorted_results(run_command, httpserver):
-    # Set up the server to serve our custom index file
-    test_index = Path(__file__).parent / "testdata" / "test_index.json"
-    httpserver.expect_request("/test_index.json").respond_with_data(test_index.read_text())
-
-    # update custom index
-    url = httpserver.url_for("/test_index.json")
-    assert run_command(["core", "update-index", f"--additional-urls={url}"])
-
-    # This is done only to avoid index update output when calling core search
-    # since it automatically updates them if they're outdated and it makes it
-    # harder to parse the list of cores
-    assert run_command(["core", "search"])
-
-    # list all with additional url specified
-    result = run_command(["core", "search", f"--additional-urls={url}"])
-    assert result.ok
-
-    lines = [l.strip().split(maxsplit=2) for l in result.stdout.strip().splitlines()][1:]
-    not_deprecated = [l for l in lines if not l[2].startswith("[DEPRECATED]")]
-    deprecated = [l for l in lines if l[2].startswith("[DEPRECATED]")]
-
-    # verify that results are already sorted correctly
-    assert not_deprecated == sorted(not_deprecated, key=lambda tokens: tokens[2].lower())
-    assert deprecated == sorted(deprecated, key=lambda tokens: tokens[2].lower())
-
-    # verify that deprecated platforms are the last ones
-    assert lines == not_deprecated + deprecated
-
-    # test same behaviour with json output
-    result = run_command(["core", "search", f"--additional-urls={url}", "--format=json"])
-    assert result.ok
-
-    platforms = json.loads(result.stdout)
-    not_deprecated = [p for p in platforms if not p.get("deprecated")]
-    deprecated = [p for p in platforms if p.get("deprecated")]
-
-    # verify that results are already sorted correctly
-    assert not_deprecated == sorted(not_deprecated, key=lambda keys: keys["name"].lower())
-    assert deprecated == sorted(deprecated, key=lambda keys: keys["name"].lower())
-    # verify that deprecated platforms are the last ones
-    assert platforms == not_deprecated + deprecated
-
-
 def test_core_list_sorted_results(run_command, httpserver):
     # Set up the server to serve our custom index file
     test_index = Path(__file__).parent / "testdata" / "test_index.json"