File Assertions

An assertion tool to verify file resources and their properties.

• GdScript
• C#

• GdUnitFileAssert
  

  Function	Description
  is_file	Verifies the given resource is a file
  exists	Verifies the given resource exists
  is_script	Verifies the given resource is a gd script
  contains_exactly	Verifies the given resource contains the content

• Not yet implemented!

---

File Assert Examples

is_file

Verifies the given resource is a file that can be opened for reading.

• GdScript
• C#

• func assert_file(<current>).is_file() -> GdUnitFileAssert
  

  # this assertion succeeds if the file exists and can be opened
  assert_file("res://test.gd").is_file()
  
  # this assertion fails if the file doesn't exist or can't be opened
  assert_file("res://nonexistent.gd").is_file()
  assert_file("res://some_directory/").is_file()
  

• Not yet implemented!

exists

Verifies the given resource exists in the file system.

• GdScript
• C#

• func assert_file(<current>).exists() -> GdUnitFileAssert
  

  # this assertion succeeds if the file exists
  assert_file("res://test.gd").exists()
  
  # this assertion fails if the file doesn't exist
  assert_file("res://nonexistent.gd").exists()
  

• Not yet implemented!

is_script

Verifies the given resource is a valid GDScript file.

• GdScript
• C#

• func assert_file(<current>).is_script() -> GdUnitFileAssert
  

  # this assertion succeeds if the file is a valid GDScript
  assert_file("res://test.gd").is_script()
  
  # this assertion fails if the file is not a GDScript
  assert_file("res://image.png").is_script()
  assert_file("res://data.json").is_script()
  
  # this assertion also fails if the file doesn't exist
  assert_file("res://nonexistent.gd").is_script()
  

• Not yet implemented!

contains_exactly

Verifies the given GDScript resource contains exactly the specified content as an array of lines.

• GdScript
• C#

• func assert_file(<current>).contains_exactly(<expected_rows> :Array) -> GdUnitFileAssert
  

  # this assertion succeeds if the script contains exactly these lines
  assert_file("res://test.gd").contains_exactly([
      "extends Node",
      "",
      "func _ready():",
      "\tprint(\"Hello World\")"
  ])
  
  # this assertion fails if the content doesn't match exactly
  assert_file("res://test.gd").contains_exactly([
      "extends Node",
      "func _ready():",
      "\tprint(\"Hello World\")"
  ])  # missing empty line
  
  # this assertion also fails if the file is not a GDScript
  assert_file("res://data.json").contains_exactly(["some content"])
  

• Not yet implemented!