test(gdscript): add GUT and an integration test

We used the latest stable GUT, but a feature we're going to need was merged today, so we'll need to update it either to master or to the next release at some point.

Author: Goutte

modules/openapi-generator/src/main/resources/gdscript/README.md

@@ -7,13 +7,17 @@ You can copy them all (or parts) and override them as needed.
 
 ## Domain Overview
 
-
 ### ApiBee
 
 Base class for all Api endpoints classes.
 Holds most of the nitty-gritty.
 
 
+### ApiConfig
+
+Reusable configuration (host, port, etc.) for Apis, injected into their constructor.
+
+
 ### ApiError
 
 Godot does not have an `Exception` (`try / catch`) mechanism, by design.

samples/client/petstore/gdscript/.gut_editor_config.json

@@ -0,0 +1,42 @@
+{
+ "background_color": "262626ff",
+ "compact_mode": false,
+ "config_file": "res://.gutconfig.json",
+ "dirs": [
+  "res://test/integration"
+ ],
+ "disable_colors": false,
+ "double_strategy": "partial",
+ "font_color": "ccccccff",
+ "font_name": "CourierPrime",
+ "font_size": 16,
+ "gut_on_top": true,
+ "hide_orphans": false,
+ "ignore_pause": false,
+ "include_subdirs": false,
+ "inner_class": null,
+ "junit_xml_file": "",
+ "junit_xml_timestamp": false,
+ "log_level": 1,
+ "opacity": 100,
+ "paint_after": 0.5,
+ "panel_options": {
+  "font_name": "CourierPrime",
+  "font_size": 30,
+  "hide_output_text": false,
+  "hide_result_tree": false,
+  "hide_settings": false,
+  "use_colors": false
+ },
+ "post_run_script": "",
+ "pre_run_script": "",
+ "prefix": "test_",
+ "selected": null,
+ "should_exit": false,
+ "should_exit_on_success": false,
+ "should_maximize": false,
+ "show_help": false,
+ "suffix": ".gd",
+ "tests": [],
+ "unit_test_name": null
+}

samples/client/petstore/gdscript/.gut_editor_shortcuts.cfg

@@ -0,0 +1,17 @@
+[main]
+
+run_all=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
+],"script":null)
+
+run_current_script=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
+],"script":null)
+
+run_current_inner=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
+],"script":null)
+
+run_current_test=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
+],"script":null)
+
+panel_button=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
+],"script":null)
+

samples/client/petstore/gdscript/.gutconfig.json

@@ -0,0 +1,32 @@
+{
+ "background_color": null,
+ "compact_mode": null,
+ "dirs": [
+  "res://test/integration"
+ ],
+ "disable_colors": null,
+ "double_strategy": null,
+ "font_color": null,
+ "font_name": null,
+ "font_size": null,
+ "gut_on_top": null,
+ "hide_orphans": null,
+ "ignore_pause": null,
+ "include_subdirs": null,
+ "inner_class": null,
+ "junit_xml_file": null,
+ "junit_xml_timestamp": null,
+ "log_level": null,
+ "opacity": null,
+ "paint_after": null,
+ "post_run_script": null,
+ "pre_run_script": null,
+ "prefix": null,
+ "selected": null,
+ "should_exit": null,
+ "should_exit_on_success": null,
+ "should_maximize": null,
+ "suffix": null,
+ "tests": null,
+ "unit_test_name": null
+}

samples/client/petstore/gdscript/README.md

@@ -19,7 +19,7 @@ See https://github.com/OpenAPITools/openapi-generator/wiki/Integration-Tests
 
 ## Run
 
-	godot --headless samples/client/petstore/gdscript
+    godot --path samples/client/petstore/gdscript -d -s addons/gut/gut_cmdln.gd
 
 The command should return a zero exit code if all tests passed.
 You may want to add `--verbose` for more logs when debugging.

samples/client/petstore/gdscript/addons/gut/GutScene.gd

@@ -0,0 +1,124 @@
+extends Node2D
+# ##############################################################################
+# This is a wrapper around the normal and compact gui controls and serves as
+# the interface between gut.gd and the gui.  The GutRunner creates an instance
+# of this and then this takes care of managing the different GUI controls.
+# ##############################################################################
+@onready var _normal_gui = $Normal
+@onready var _compact_gui = $Compact
+var gut = null :
+	set(val):
+		gut = val
+		_set_gut(val)
+
+
+func _ready():
+	_normal_gui.switch_modes.connect(use_compact_mode.bind(true))
+	_compact_gui.switch_modes.connect(use_compact_mode.bind(false))
+
+	_normal_gui.set_title("GUT")
+	_compact_gui.set_title("GUT")
+
+	_normal_gui.align_right()
+	_compact_gui.to_bottom_right()
+
+	use_compact_mode(false)
+	
+	if(get_parent() == get_tree().root):
+		_test_running_setup()
+
+func _test_running_setup():
+	_normal_gui.get_textbox().text = "hello world, how are you doing?"
+
+# ------------------------
+# Private
+# ------------------------
+func _set_gut(val):
+	_normal_gui.set_gut(val)
+	_compact_gui.set_gut(val)
+
+	val.start_run.connect(_on_gut_start_run)
+	val.end_run.connect(_on_gut_end_run)
+	val.start_pause_before_teardown.connect(_on_gut_pause)
+	val.end_pause_before_teardown.connect(_on_pause_end)
+
+func _set_both_titles(text):
+	_normal_gui.set_title(text)
+	_compact_gui.set_title(text)
+
+
+# ------------------------
+# Events
+# ------------------------
+func _on_gut_start_run():
+	_set_both_titles('Running')
+
+func _on_gut_end_run():
+	_set_both_titles('Finished')
+
+func _on_gut_pause():
+	_set_both_titles('-- Paused --')
+
+func _on_pause_end():
+	_set_both_titles('Running')
+
+
+# ------------------------
+# Public
+# ------------------------
+func get_textbox():
+	return _normal_gui.get_textbox()
+
+
+func set_font_size(new_size):
+	return
+	var rtl = _normal_gui.get_textbox()
+	if(rtl.get('custom_fonts/normal_font') != null):
+		rtl.get('custom_fonts/bold_italics_font').size = new_size
+		rtl.get('custom_fonts/bold_font').size = new_size
+		rtl.get('custom_fonts/italics_font').size = new_size
+		rtl.get('custom_fonts/normal_font').size = new_size
+
+
+func set_font(font_name):
+	_set_all_fonts_in_rtl(_normal_gui.get_textbox(), font_name)
+
+
+func _set_font(rtl, font_name, custom_name):
+	if(font_name == null):
+		rtl.add_theme_font_override(custom_name, null)
+	else:
+		var dyn_font = FontFile.new()
+		dyn_font.load_dynamic_font('res://addons/gut/fonts/' + font_name + '.ttf')
+		rtl.add_theme_font_override(custom_name, dyn_font)
+
+
+func _set_all_fonts_in_rtl(rtl, base_name):
+	if(base_name == 'Default'):
+		_set_font(rtl, null, 'normal_font')
+		_set_font(rtl, null, 'bold_font')
+		_set_font(rtl, null, 'italics_font')
+		_set_font(rtl, null, 'bold_italics_font')
+	else:
+		_set_font(rtl, base_name + '-Regular', 'normal_font')
+		_set_font(rtl, base_name + '-Bold', 'bold_font')
+		_set_font(rtl, base_name + '-Italic', 'italics_font')
+		_set_font(rtl, base_name + '-BoldItalic', 'bold_italics_font')
+
+
+func set_default_font_color(color):
+	_normal_gui.get_textbox().set('custom_colors/default_color', color)
+
+
+func set_background_color(color):
+	_normal_gui.set_bg_color(color)
+
+
+func use_compact_mode(should=true):
+	_compact_gui.visible = should
+	_normal_gui.visible = !should
+
+
+func set_opacity(val):
+	_normal_gui.modulate.a = val
+	_compact_gui.modulate.a = val

samples/client/petstore/gdscript/addons/gut/GutScene.tscn

@@ -0,0 +1,16 @@
+[gd_scene load_steps=4 format=3 uid="uid://m28heqtswbuq"]
+
+[ext_resource type="Script" path="res://addons/gut/GutScene.gd" id="1_b4m8y"]
+[ext_resource type="PackedScene" uid="uid://duxblir3vu8x7" path="res://addons/gut/gui/NormalGui.tscn" id="2_j6ywb"]
+[ext_resource type="PackedScene" uid="uid://cnqqdfsn80ise" path="res://addons/gut/gui/MinGui.tscn" id="3_3glw1"]
+
+[node name="GutScene" type="Node2D"]
+script = ExtResource("1_b4m8y")
+
+[node name="Normal" parent="." instance=ExtResource("2_j6ywb")]
+
+[node name="Compact" parent="." instance=ExtResource("3_3glw1")]
+offset_left = 5.0
+offset_top = 273.0
+offset_right = 265.0
+offset_bottom = 403.0

samples/client/petstore/gdscript/addons/gut/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2018 Tom "Butch" Wesley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

samples/client/petstore/gdscript/addons/gut/UserFileViewer.gd

@@ -0,0 +1,52 @@
+extends Window
+
+@onready var rtl = $TextDisplay/RichTextLabel
+
+func _get_file_as_text(path):
+	var to_return = null
+	var f = FileAccess.open(path, FileAccess.READ)
+	if(f != null):
+		to_return = f.get_as_text()
+	else:
+		to_return = str('ERROR:  Could not open file.  Error code ', FileAccess.get_open_error())
+	return to_return
+
+func _ready():
+	rtl.clear()
+
+func _on_OpenFile_pressed():
+	$FileDialog.popup_centered()
+
+func _on_FileDialog_file_selected(path):
+	show_file(path)
+
+func _on_Close_pressed():
+	self.hide()
+
+func show_file(path):
+	var text = _get_file_as_text(path)
+	if(text == ''):
+		text = '<Empty File>'
+	rtl.set_text(text)
+	self.window_title = path
+
+func show_open():
+	self.popup_centered()
+	$FileDialog.popup_centered()
+
+func get_rich_text_label():
+	return $TextDisplay/RichTextLabel
+
+func _on_Home_pressed():
+	rtl.scroll_to_line(0)
+
+func _on_End_pressed():
+	rtl.scroll_to_line(rtl.get_line_count() -1)
+
+func _on_Copy_pressed():
+	return
+	# OS.clipboard = rtl.text
+
+func _on_file_dialog_visibility_changed():
+	if rtl.text.length() == 0 and not $FileDialog.visible:
+		self.hide()