diff --git a/config.json b/config.json index 46df2f0..2c03da1 100644 --- a/config.json +++ b/config.json @@ -454,6 +454,14 @@ "prerequisites": [], "difficulty": 5 }, + { + "slug": "linked-list", + "name": "Linked List", + "uuid": "c9a57acf-9f9f-4973-b22e-252bdef18ed1", + "practices": [], + "prerequisites": [], + "difficulty": 5 + }, { "slug": "nth-prime", "name": "Nth Prime", diff --git a/exercises/practice/linked-list/.docs/instructions.md b/exercises/practice/linked-list/.docs/instructions.md new file mode 100644 index 0000000..edf4055 --- /dev/null +++ b/exercises/practice/linked-list/.docs/instructions.md @@ -0,0 +1,26 @@ +# Instructions + +Your team has decided to use a doubly linked list to represent each train route in the schedule. +Each station along the train's route will be represented by a node in the linked list. + +You don't need to worry about arrival and departure times at the stations. +Each station will simply be represented by a number. + +Routes can be extended, adding stations to the beginning or end of a route. +They can also be shortened by removing stations from the beginning or the end of a route. + +Sometimes a station gets closed down, and in that case the station needs to be removed from the route, even if it is not at the beginning or end of the route. + +The size of a route is measured not by how far the train travels, but by how many stations it stops at. + +~~~~exercism/note +The linked list is a fundamental data structure in computer science, often used in the implementation of other data structures. +As the name suggests, it is a list of nodes that are linked together. +It is a list of "nodes", where each node links to its neighbor or neighbors. +In a **singly linked list** each node links only to the node that follows it. +In a **doubly linked list** each node links to both the node that comes before, as well as the node that comes after. + +If you want to dig deeper into linked lists, check out [this article][intro-linked-list] that explains it using nice drawings. + +[intro-linked-list]: https://medium.com/basecs/whats-a-linked-list-anyway-part-1-d8b7e6508b9d +~~~~ diff --git a/exercises/practice/linked-list/.docs/introduction.md b/exercises/practice/linked-list/.docs/introduction.md new file mode 100644 index 0000000..6e83ae7 --- /dev/null +++ b/exercises/practice/linked-list/.docs/introduction.md @@ -0,0 +1,6 @@ +# Introduction + +You are working on a project to develop a train scheduling system for a busy railway network. + +You've been asked to develop a prototype for the train routes in the scheduling system. +Each route consists of a sequence of train stations that a given train stops at. diff --git a/exercises/practice/linked-list/.meta/config.json b/exercises/practice/linked-list/.meta/config.json new file mode 100644 index 0000000..1c5d0d7 --- /dev/null +++ b/exercises/practice/linked-list/.meta/config.json @@ -0,0 +1,21 @@ +{ + "authors": [ + "IsaacG" + ], + "files": { + "solution": [ + "linked_list.gd" + ], + "test": [ + "linked_list_test.gd", + "run_tests", + "lib/test_runner.gd", + "project.godot" + ], + "example": [ + ".meta/example.gd" + ] + }, + "blurb": "Implement a doubly linked list.", + "source": "Classic computer science topic" +} diff --git a/exercises/practice/linked-list/.meta/example.gd b/exercises/practice/linked-list/.meta/example.gd new file mode 100644 index 0000000..21e4479 --- /dev/null +++ b/exercises/practice/linked-list/.meta/example.gd @@ -0,0 +1,73 @@ +class ListNode: + + var _prev = null + var _next = null + var _val = null + + func _init(value): + _val = value + + func add_prev(value): + var new = ListNode.new(value) + link(_prev, new, self) + return new + + func add_next(value): + var new = ListNode.new(value) + link(self, new, _next) + return new + + func link(a, b, c): + a._next = b + b._next = c + c._prev = b + b._prev = a + + func remove(): + _next._prev = _prev + _prev._next = _next + return _val + + +class LinkedList: + + var _head = null + var _tail = null + var _len = 0 + + func _init(): + _head = ListNode.new(null) + _tail = ListNode.new(null) + _head._next = _tail + _tail._prev = _head + + func push(value): + _tail.add_prev(value) + _len += 1 + + func unshift(value): + _head.add_next(value) + _len += 1 + + func delete(value): + var cur = _head._next + while cur != _tail and cur._val != value: + cur = cur._next + if cur._val != value: + return + cur.remove() + _len -= 1 + + func remove(node): + var val = node.remove() + _len -= 1 + return val + + func pop(): + return remove(_tail._prev) + + func shift(): + return remove(_head._next) + + func count(): + return _len diff --git a/exercises/practice/linked-list/.meta/template.j2 b/exercises/practice/linked-list/.meta/template.j2 new file mode 100644 index 0000000..d9e4e2d --- /dev/null +++ b/exercises/practice/linked-list/.meta/template.j2 @@ -0,0 +1,26 @@ +{% for case in cases %} +func test_{{ case.func_name }}(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 +{% for op in case.input.operations %} +{%- if op.operation == "count" %} + res = linked_list.count() + if res != {{ op.expected }}: + return [false, "count() = %d; expected %d" % [res, {{ op.expected }}]] +{%- elif (op.operation == "pop" or op.operation == "shift") and "expected" in op %} + res = linked_list.{{ op.operation }}() + if res != {{ op.expected }}: + return [false, "{{ op.operation }}() = %d; expected %d" % [res, {{ op.expected }}]] +{%- elif op.operation == "pop" or op.operation == "shift" %} + linked_list.{{ op.operation }}() +{%- elif op.operation == "push" or op.operation == "unshift" %} + linked_list.{{ op.operation }}({{ op.value }}) +{%- elif op.operation == "delete" %} + linked_list.{{ op.operation }}({{ op.value }}) +{%- else %} + {{ "Invalid op" | raise_error }} +{%- endif %} +{% endfor %} + return [true, true] + +{% endfor %} diff --git a/exercises/practice/linked-list/.meta/tests.toml b/exercises/practice/linked-list/.meta/tests.toml new file mode 100644 index 0000000..96906d2 --- /dev/null +++ b/exercises/practice/linked-list/.meta/tests.toml @@ -0,0 +1,67 @@ +# This is an auto-generated file. +# +# Regenerating this file via `configlet sync` will: +# - Recreate every `description` key/value pair +# - Recreate every `reimplements` key/value pair, where they exist in problem-specifications +# - Remove any `include = true` key/value pair (an omitted `include` key implies inclusion) +# - Preserve any other key/value pair +# +# As user-added comments (using the # character) will be removed when this file +# is regenerated, comments can be added via a `comment` key. + +[7f7e3987-b954-41b8-8084-99beca08752c] +description = "pop gets element from the list" + +[c3f67e5d-cfa2-4c3e-a18f-7ce999c3c885] +description = "push/pop respectively add/remove at the end of the list" + +[00ea24ce-4f5c-4432-abb4-cc6e85462657] +description = "shift gets an element from the list" + +[37962ee0-3324-4a29-b588-5a4c861e6564] +description = "shift gets first element from the list" + +[30a3586b-e9dc-43fb-9a73-2770cec2c718] +description = "unshift adds element at start of the list" + +[042f71e4-a8a7-4cf0-8953-7e4f3a21c42d] +description = "pop, push, shift, and unshift can be used in any order" + +[88f65c0c-4532-4093-8295-2384fb2f37df] +description = "count an empty list" + +[fc055689-5cbe-4cd9-b994-02e2abbb40a5] +description = "count a list with items" + +[8272cef5-130d-40ea-b7f6-5ffd0790d650] +description = "count is correct after mutation" + +[229b8f7a-bd8a-4798-b64f-0dc0bb356d95] +description = "popping to empty doesn't break the list" + +[4e1948b4-514e-424b-a3cf-a1ebbfa2d1ad] +description = "shifting to empty doesn't break the list" + +[e8f7c600-d597-4f79-949d-8ad8bae895a6] +description = "deletes the only element" + +[fd65e422-51f3-45c0-9fd0-c33da638f89b] +description = "deletes the element with the specified value from the list" + +[59db191a-b17f-4ab7-9c5c-60711ec1d013] +description = "deletes the element with the specified value from the list, re-assigns tail" + +[58242222-5d39-415b-951d-8128247f8993] +description = "deletes the element with the specified value from the list, re-assigns head" + +[ee3729ee-3405-4bd2-9bad-de0d4aa5d647] +description = "deletes the first of two elements" + +[47e3b3b4-b82c-4c23-8c1a-ceb9b17cb9fb] +description = "deletes the second of two elements" + +[7b420958-f285-4922-b8f9-10d9dcab5179] +description = "delete does not modify the list if the element is not found" + +[7e04828f-6082-44e3-a059-201c63252a76] +description = "deletes only the first occurrence" diff --git a/exercises/practice/linked-list/lib/test_runner.gd b/exercises/practice/linked-list/lib/test_runner.gd new file mode 100644 index 0000000..be91311 --- /dev/null +++ b/exercises/practice/linked-list/lib/test_runner.gd @@ -0,0 +1,541 @@ +class_name TestRunner +extends SceneTree + + +class ErrorReader: + """ErrorReader reads from a STDERR file (cmd 2>/file). + + It filters out the less useful Godot output and handles retrieving lines iteratively. + """ + + const EXPECTED_GODOT_ERRORS = [ + ( + "ERROR: Could not create directory: /root/.local\n" + + " at: make_dir_recursive (core/io/dir_access.cpp:180)\n" + ), + ( + "ERROR: Error attempting to create data dir: " + + "/root/.local/share/godot/app_userdata/[unnamed project].\n" + + " at: ensure_user_data_dir (core/os/os.cpp:344)\n" + ), + ( + "ERROR: Could not create editor data directory: /root/.local/share/godot\n" + + " at: EditorPaths (editor/editor_paths.cpp:183)\n" + ), + ( + "ERROR: Could not create directory: /root/.config\n" + + " at: make_dir_recursive (core/io/dir_access.cpp:180)\n" + ), + ( + "ERROR: Could not create editor config directory: /root/.config/godot\n" + + " at: EditorPaths (editor/editor_paths.cpp:198)\n" + ), + ( + "ERROR: Could not create directory: /root/.cache\n" + + " at: make_dir_recursive (core/io/dir_access.cpp:180)\n" + ), + ( + "ERROR: Could not create editor cache directory: /root/.cache/godot\n" + + " at: EditorPaths (editor/editor_paths.cpp:219)\n" + ), + ( + "ERROR: Can't save resource to empty path. " + + "Provide non-empty path or a Resource with non-empty resource_path.\n" + + " at: save (core/io/resource_saver.cpp:105)\n" + ), + ( + "ERROR: Error saving editor settings to \n" + + " at: save (editor/editor_settings.cpp:1013)\n" + ), + ] + var already_processed_bytes: int = 0 + var filename: String = "" + var color_sequence = RegEx.create_from_string("\\e\\[\\d[\\d;]*m") + + func _init(filename: String) -> void: + self.already_processed_bytes = 0 + self.filename = filename + if not self.filename.is_empty() and ResourceLoader.exists(self.filename): + self.get_error_message() + + func check() -> Error: + if not FileAccess.file_exists(self.filename): + push_error("STDERR must be redirected to '%s' when using '--json'" % self.filename) + return ERR_FILE_NOT_FOUND + if OS.get_stderr_type() != OS.STD_HANDLE_FILE: + push_error("STDERR must be redirected to '%s' when using '--json'" % self.filename) + return ERR_FILE_NOT_FOUND + return OK + + func get_error_message() -> String: + """ + Checks the contents of the STDERR file, where error output from the + currently running test suite should be stored. If there is any relevant output + there, this method will return it. If the file is empty, an empty string is returned. + + This method will remove previously read output from the returned message. It should + be called after executing every test, to ensure that the message contains only output + relevant for the given test. + + NOTE: running a Godot instance without full access to certain folders in the + home directory (`~/.config`, `~/.local`, `~/.cache`) will result in additional + errors. This happens when GDScript test runner is executed in Docker. However, + these errors do not stop the execution of the program, so they can be ignored. + This method filters them out, leaving only the errors caused by the actual tests. + """ + if self.filename.is_empty(): + return "" + + var error_output = FileAccess.get_file_as_string(self.filename) + error_output = error_output.erase(0, self.already_processed_bytes) + self.already_processed_bytes += len(error_output) + + # By default, Godot's error messages are printed with colors. To include the output in the + # `results.json` file, color markers need to be removed first. + error_output = self.color_sequence.sub(error_output, "", true) + + # Filter out the expected error messages + for expected_error in EXPECTED_GODOT_ERRORS: + error_output = error_output.replace(expected_error, "") + + return error_output + + +class ResultWriter: + var json_file: String = "" + var stderr: ErrorReader = null + + func _init(json_file: String, stderr: ErrorReader) -> void: + self.json_file = json_file + self.stderr = stderr + + func delete_existing() -> Error: + """ + Removes the previous `results.json` file, to ensure that the current test suite will not use it. + """ + if self.json_file.is_empty(): + return OK + if FileAccess.file_exists(self.json_file): + DirAccess.remove_absolute(self.json_file) + var error_message: String = self.stderr.get_error_message() + if not error_message.is_empty(): + push_error(error_message) + return FAILED + return OK + + func write(results: Dictionary) -> Error: + """ + If output_dir_path is empty, outputs friendly-formatted test results to + stdout. + + Otherwise, writes JSON results to results.json in the given path. + """ + if self.json_file.is_empty(): + return print_friendly_results(results) + return write_results_file(results) + + func print_friendly_results(results: Dictionary) -> Error: + """ + Prints rich results to stdout. + """ + var rich_results = [""] + if results.status == "pass": + rich_results.push_back("[color=yellow]Exercise passed! Nicely done![/color]") + else: + rich_results.push_back("Exercise has at least one failed test:") + for test in results.tests: + if test.status == "pass": + rich_results.push_back(" %s [color=yellow]passed ✔[/color]" % test.name) + else: + rich_results.push_back( + " %s [color=pink]failed: %s[/color]" % [test.name, test.message] + ) + print_rich("\n".join(rich_results)) + return OK + + func write_results_file(results: Dictionary) -> Error: + """ + Saves a dictionary as a `results.json` file in the output directory. The file + is indented with 4 spaces, keys are not sorted. + + The `results` dictionary represents the full output of a single exercise's + test suite, according to the Test Runner Interface documentation: + + https://exercism.org/docs/building/tooling/test-runners/interface + + This method automatically adds `'version' = 2` to the results. + """ + # Due to keys not being sorted, `version` should be inserted first + var full_results = {"version": 2} + full_results.merge(results) + + var pretty_results = JSON.stringify(full_results, " ", false) + + var results_json = FileAccess.open(self.json_file, FileAccess.WRITE) + if results_json == null: + var err = FileAccess.get_open_error() + push_error("Failed to write the file: %s (%s)" % [self.json_file, error_string(err)]) + return err + + results_json.store_string(pretty_results + "\n") + return OK + + +class ArgParser: + """ArgParser reads the cmdline and parses inputs and options.""" + + var solution_script_path: String = "" + var test_suite_script_path: String = "" + var run_all: bool = false + var json: bool = false + var json_file: String = "" + + func usage(message: String) -> void: + print("Usage:") + print("test_runner [--all] [--json filename.json] ") + if not message.is_empty(): + print() + print(message) + + func parse_args() -> Error: + """ + Validates the number of args passed to the script and sets values of the following + global variables, based on the given args: + * `solution_script_path` + * `test_suite_script_path` + """ + var args = OS.get_cmdline_user_args() + var positional: Array = [] + + var idx := 0 + while idx < len(args): + var arg = args[idx] + if arg == "--all": + run_all = true + elif arg.begins_with("--json"): + if arg.contains("="): + var parts = arg.split("=", true, 1) + if parts[0] == "--json": + self.json = true + self.json_file = parts[1] + else: + usage("Invalid flag %s" % arg) + return ERR_INVALID_PARAMETER + elif idx + 1 < len(args): + self.json = true + self.json_file = args[idx + 1] + idx += 1 + else: + usage("Flag %s is missing a filename" % arg) + return ERR_INVALID_PARAMETER + elif arg.begins_with("--"): + usage("Invalid flag %s" % arg) + return ERR_INVALID_PARAMETER + else: + positional.append(arg) + idx += 1 + + if len(positional) != 2: + usage("Expecting 2 positional args but got %d" % len(positional)) + return ERR_INVALID_PARAMETER + + var slug = positional[0] + var solution_dir_path = positional[1] + + # Test folders use dashes, but test files use underscores + var gdscript_path = solution_dir_path.path_join(slug.replace("-", "_")) + + self.solution_script_path = gdscript_path + ".gd" + self.test_suite_script_path = gdscript_path + "_test.gd" + + return OK + + func files() -> Array: + return [self.solution_script_path, self.test_suite_script_path] + + +class Runner: + var test_suite: Object = null + var solution: Object = null + var stderr: ErrorReader = null + var result_writer: ResultWriter = null + + func _init( + test_suite: Object, solution: Object, stderr: ErrorReader, result_writer: ResultWriter + ) -> void: + self.test_suite = test_suite + self.solution = solution + self.stderr = stderr + self.result_writer = result_writer + + func extract_methods() -> Dictionary: + """Extract the source code of a method from a script.""" + var in_func: bool = false + var parts = [] + var methods: Dictionary = {} + var name: String = "" + var func_re: RegEx = RegEx.create_from_string("^func ([^(]+)\\(") + for line in self.test_suite.get_script().source_code.split("\n"): + if not in_func: + var matched = func_re.search(line) + if matched: + in_func = true + name = matched.get_strings()[1] + parts = [] + elif not line.begins_with("\t") and not line.begins_with(" "): + if in_func: + in_func = false + methods[name] = "\n".join(parts) + else: + parts.append(line) + + return methods + + func get_failed_test_message(actual, expected) -> String: + """ + Generates a message for a failed test. If given values are strings, + this method will wrap them in single quotes, to distinguish from + other types, like integers (e.g. '3' vs 3). + + This method should be used if the actual and expected values for a + given test are different, or if they have different types. + """ + var values = [] + + for value in [actual, expected]: + var formatted_value = str(value) + if typeof(value) == TYPE_STRING: + formatted_value = "'{0}'".format([formatted_value]) + values.append(formatted_value) + + return "Expected output was {1}, actual output was {0}.".format(values) + + func run_tests() -> Array: + """ + Runs the given test suite agains the given solution script. Returns an Array + representing the results of each test case, in the same order that they are defined + in the test suite. Each test result is a Dictionary containing 3 values: + + * `name`: the name of the test case + * `status`: 'pass', 'fail', or 'error' + * `message`: null if the test passed, otherwise it contains the details of the failure/error + + This method will look for methods starting with `test_` in the test script, and + then call them with the solution script as the only argument. The `test_` method's + name will be used as the `name` value for each test result. + + If any stderr output was generated during the execution of the `test_` method, + `status` will be set to 'error'. The test will also receive an 'error' status + if calling the `test_` method returned null (which indicates execution issues). + + Otherwise, the `test_` method should return an Array of 2 elements: the actual value, + and the expected value. The values will be compared and if they are the same, the test will + pass. Otherwise, it will fail, with a relevant message being set by this method. + """ + var test_results = [] + var test_codes = self.extract_methods() + + for method in self.test_suite.get_method_list(): + if not method["name"].begins_with("test_"): + continue + var test_method_name = method["name"] + print("-> " + test_method_name) + var test_method = self.test_suite.get(test_method_name) + + var output = test_method.call(self.solution) + var error_message = self.stderr.get_error_message() + + if output == null: + ( + test_results + . append( + { + "name": test_method_name, + "status": "error", + "message": error_message, + } + ) + ) + else: + var actual = output[0] + var expected = output[1] + + var passed = ( + typeof(actual) == typeof(expected) + and actual == expected + and error_message.is_empty() + ) + + var status = "error" + if error_message.is_empty(): + status = "pass" if passed else "fail" + error_message = ( + null if passed else self.get_failed_test_message(actual, expected) + ) + + var test_code = test_codes[method["name"]] + # The code would be cleaner if the test suite actually checked the values. + # Instead, the test suite returns an array with two values which are compared (above). + # This `replace()` hides some of that implementation detail by communicating that the + # array elements are being compared for equality. + test_code = test_code.replace("return [", "assert_equal [") + test_code = test_code.replace("\t", " ") + test_code = test_code.dedent().strip_edges() + + ( + test_results + . append( + { + "name": test_method_name, + "status": status, + "message": error_message, + "test_code": test_code, + } + ) + ) + + return test_results + + func run(run_all: bool) -> void: + """ + Executes the current suite against the current solution. Stores the results in the + `results.json` file in the output dir. + """ + var test_results = run_tests() + var results = {} + + # Check if any tests were executed + if len(test_results) == 0: + results = {"status": "error", "message": "No tests were executed.", "tests": []} + else: + results = {"status": "pass", "tests": test_results} + + # If any of the tests failed, change the global status to `fail` + for test_result in test_results: + if test_result["status"] != "pass": + results["status"] = "fail" + break + + if not run_all and results["status"] != "pass": + var success_count: int = 0 + for test_result in test_results: + if test_result["status"] == "pass": + success_count += 1 + + var has_failure = false + var filtered_results = [] + for test_result in test_results: + if test_result["status"] == "pass": + filtered_results.append(test_result) + elif not has_failure: + has_failure = true + test_result["message"] = ( + "Passes %d/%d tests. First failure: %s" + % [ + success_count, + len(test_results), + test_result["message"], + ] + ) + filtered_results.append(test_result) + results["tests"] = filtered_results + + self.result_writer.write(results) + + +func load_solution(path: String) -> Object: + """Load a script. This helper is needed to catch failures without aborting the error handling.""" + if not FileAccess.file_exists(path): + return null + var re = RegEx.create_from_string("^( )+") + var replace = RegEx.create_from_string("( )+") + var changed = false + var lines = [] + for line in FileAccess.open(path, FileAccess.READ).get_as_text().split("\n"): + var m = re.search(line) + if m == null: + lines.append(line) + else: + changed = true + var new = [] + for i in range(m.get_end() / 4): + new.append("\t") + new.append(line.substr(m.get_end())) + lines.append("".join(new)) + if not changed: + return load(path).new() + + path = OS.get_temp_dir() + "/solution.gd" + FileAccess.open(path, FileAccess.WRITE).store_string("\n".join(lines)) + var solution = load(path).new() + DirAccess.remove_absolute(path) + return solution + + +func load_solution_script( + solution_script_path: String, result_writer: ResultWriter, stderr: ErrorReader +) -> Array: + """ + Loads the solution script and saves it in a global variable. In case of any + issues, this method will save the `results.json` file with `error` status. + """ + # Make sure the STDERR file is empty. + stderr.get_error_message() + var solution_script = load_solution(solution_script_path) + + if solution_script == null: + var message: String = "The solution file could not be parsed." + # Extract the error message, up until the "Failed to load" line + # which is specific to the test runner, not the user's solution. + var error_message: String = stderr.get_error_message() + if not error_message.is_empty(): + var msg = [] + var stop = ( + 'ERROR: Failed to load script "%s" with error "Parse error".' % solution_script_path + ) + for line in error_message.split("\n"): + if line == stop: + break + msg.append(line) + message += "\n" + "\n".join(msg) + var results = {"status": "error", "message": message, "tests": []} + result_writer.write(results) + return [null, ERR_PARSE_ERROR] + + return [solution_script, OK] + + +func _init(): + # Calling `quit(1)` doesn't stop the program immediately, so a `return` is necessary. + # That's why errors are checked directly in `_init()`, instead of calling `quit(1)` + # in each method. + var args = ArgParser.new() + if args.parse_args() != OK: + quit(1) + return + for file in args.files(): + if not ResourceLoader.exists(file): + push_error("File %s not found." % file) + quit(1) + return + + var stderr = ErrorReader.new("/tmp/stderr") + if args.json and stderr.check() != OK: + quit(1) + return + + var result_writer = ResultWriter.new(args.json_file, stderr) + if result_writer.delete_existing() != OK: + quit(1) + return + + var r = load_solution_script(args.solution_script_path, result_writer, stderr) + if r[1] != OK: + quit(1) + return + var solution = r[0] + + var test_suite = load(args.test_suite_script_path).new() + + Runner.new(test_suite, solution, stderr, result_writer).run(args.run_all) + quit() diff --git a/exercises/practice/linked-list/linked_list.gd b/exercises/practice/linked-list/linked_list.gd new file mode 100644 index 0000000..5a6f4eb --- /dev/null +++ b/exercises/practice/linked-list/linked_list.gd @@ -0,0 +1,19 @@ +class LinkedList: + + func push(value): + pass + + func unshift(value): + pass + + func delete(value): + pass + + func pop(): + pass + + func shift(): + pass + + func count(): + pass diff --git a/exercises/practice/linked-list/linked_list_test.gd b/exercises/practice/linked-list/linked_list_test.gd new file mode 100644 index 0000000..7033fc8 --- /dev/null +++ b/exercises/practice/linked-list/linked_list_test.gd @@ -0,0 +1,411 @@ +func test_pop_gets_element_from_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(7) + + res = linked_list.pop() + if res != 7: + return [false, "pop() = %d; expected %d" % [res, 7]] + + return [true, true] + + +func test_push_pop_respectively_add_remove_at_the_end_of_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(11) + + linked_list.push(13) + + res = linked_list.pop() + if res != 13: + return [false, "pop() = %d; expected %d" % [res, 13]] + + res = linked_list.pop() + if res != 11: + return [false, "pop() = %d; expected %d" % [res, 11]] + + return [true, true] + + +func test_shift_gets_an_element_from_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(17) + + res = linked_list.shift() + if res != 17: + return [false, "shift() = %d; expected %d" % [res, 17]] + + return [true, true] + + +func test_shift_gets_first_element_from_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(23) + + linked_list.push(5) + + res = linked_list.shift() + if res != 23: + return [false, "shift() = %d; expected %d" % [res, 23]] + + res = linked_list.shift() + if res != 5: + return [false, "shift() = %d; expected %d" % [res, 5]] + + return [true, true] + + +func test_unshift_adds_element_at_start_of_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.unshift(23) + + linked_list.unshift(5) + + res = linked_list.shift() + if res != 5: + return [false, "shift() = %d; expected %d" % [res, 5]] + + res = linked_list.shift() + if res != 23: + return [false, "shift() = %d; expected %d" % [res, 23]] + + return [true, true] + + +func test_pop_push_shift_and_unshift_can_be_used_in_any_order(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(1) + + linked_list.push(2) + + res = linked_list.pop() + if res != 2: + return [false, "pop() = %d; expected %d" % [res, 2]] + + linked_list.push(3) + + res = linked_list.shift() + if res != 1: + return [false, "shift() = %d; expected %d" % [res, 1]] + + linked_list.unshift(4) + + linked_list.push(5) + + res = linked_list.shift() + if res != 4: + return [false, "shift() = %d; expected %d" % [res, 4]] + + res = linked_list.pop() + if res != 5: + return [false, "pop() = %d; expected %d" % [res, 5]] + + res = linked_list.shift() + if res != 3: + return [false, "shift() = %d; expected %d" % [res, 3]] + + return [true, true] + + +func test_count_an_empty_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + res = linked_list.count() + if res != 0: + return [false, "count() = %d; expected %d" % [res, 0]] + + return [true, true] + + +func test_count_a_list_with_items(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(37) + + linked_list.push(1) + + res = linked_list.count() + if res != 2: + return [false, "count() = %d; expected %d" % [res, 2]] + + return [true, true] + + +func test_count_is_correct_after_mutation(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(31) + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + linked_list.unshift(43) + + res = linked_list.count() + if res != 2: + return [false, "count() = %d; expected %d" % [res, 2]] + + linked_list.shift() + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + linked_list.pop() + + res = linked_list.count() + if res != 0: + return [false, "count() = %d; expected %d" % [res, 0]] + + return [true, true] + + +func test_popping_to_empty_doesn_t_break_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(41) + + linked_list.push(59) + + linked_list.pop() + + linked_list.pop() + + linked_list.push(47) + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + res = linked_list.pop() + if res != 47: + return [false, "pop() = %d; expected %d" % [res, 47]] + + return [true, true] + + +func test_shifting_to_empty_doesn_t_break_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(41) + + linked_list.push(59) + + linked_list.shift() + + linked_list.shift() + + linked_list.push(47) + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + res = linked_list.shift() + if res != 47: + return [false, "shift() = %d; expected %d" % [res, 47]] + + return [true, true] + + +func test_deletes_the_only_element(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(61) + + linked_list.delete(61) + + res = linked_list.count() + if res != 0: + return [false, "count() = %d; expected %d" % [res, 0]] + + return [true, true] + + +func test_deletes_the_element_with_the_specified_value_from_the_list(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(71) + + linked_list.push(83) + + linked_list.push(79) + + linked_list.delete(83) + + res = linked_list.count() + if res != 2: + return [false, "count() = %d; expected %d" % [res, 2]] + + res = linked_list.pop() + if res != 79: + return [false, "pop() = %d; expected %d" % [res, 79]] + + res = linked_list.shift() + if res != 71: + return [false, "shift() = %d; expected %d" % [res, 71]] + + return [true, true] + + +func test_deletes_the_element_with_the_specified_value_from_the_list_re_assigns_tail(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(71) + + linked_list.push(83) + + linked_list.push(79) + + linked_list.delete(83) + + res = linked_list.count() + if res != 2: + return [false, "count() = %d; expected %d" % [res, 2]] + + res = linked_list.pop() + if res != 79: + return [false, "pop() = %d; expected %d" % [res, 79]] + + res = linked_list.pop() + if res != 71: + return [false, "pop() = %d; expected %d" % [res, 71]] + + return [true, true] + + +func test_deletes_the_element_with_the_specified_value_from_the_list_re_assigns_head(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(71) + + linked_list.push(83) + + linked_list.push(79) + + linked_list.delete(83) + + res = linked_list.count() + if res != 2: + return [false, "count() = %d; expected %d" % [res, 2]] + + res = linked_list.shift() + if res != 71: + return [false, "shift() = %d; expected %d" % [res, 71]] + + res = linked_list.shift() + if res != 79: + return [false, "shift() = %d; expected %d" % [res, 79]] + + return [true, true] + + +func test_deletes_the_first_of_two_elements(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(97) + + linked_list.push(101) + + linked_list.delete(97) + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + res = linked_list.pop() + if res != 101: + return [false, "pop() = %d; expected %d" % [res, 101]] + + return [true, true] + + +func test_deletes_the_second_of_two_elements(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(97) + + linked_list.push(101) + + linked_list.delete(101) + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + res = linked_list.pop() + if res != 97: + return [false, "pop() = %d; expected %d" % [res, 97]] + + return [true, true] + + +func test_delete_does_not_modify_the_list_if_the_element_is_not_found(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(89) + + linked_list.delete(103) + + res = linked_list.count() + if res != 1: + return [false, "count() = %d; expected %d" % [res, 1]] + + return [true, true] + + +func test_deletes_only_the_first_occurrence(solution_script): + var linked_list = solution_script.LinkedList.new() + var res = 0 + + linked_list.push(73) + + linked_list.push(9) + + linked_list.push(9) + + linked_list.push(107) + + linked_list.delete(9) + + res = linked_list.count() + if res != 3: + return [false, "count() = %d; expected %d" % [res, 3]] + + res = linked_list.pop() + if res != 107: + return [false, "pop() = %d; expected %d" % [res, 107]] + + res = linked_list.pop() + if res != 9: + return [false, "pop() = %d; expected %d" % [res, 9]] + + res = linked_list.pop() + if res != 73: + return [false, "pop() = %d; expected %d" % [res, 73]] + + return [true, true] diff --git a/exercises/practice/linked-list/project.godot b/exercises/practice/linked-list/project.godot new file mode 100644 index 0000000..b589605 --- /dev/null +++ b/exercises/practice/linked-list/project.godot @@ -0,0 +1,5 @@ +config_version=5 + +[application] +config/name="Exercism - Linked List" +config/features=PackedStringArray("4.7") diff --git a/exercises/practice/linked-list/run_tests b/exercises/practice/linked-list/run_tests new file mode 100755 index 0000000..ed18a90 --- /dev/null +++ b/exercises/practice/linked-list/run_tests @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +slug=${PWD##*/} +[[ -f "${slug//-/_}.gd" ]] || die "Error! solution file is missing" +[[ -f "${slug//-/_}_test.gd" ]] || die "Error! test file is missing" +exec godot --headless --script ./lib/test_runner.gd -- "${slug}" "${PWD}"