LUA testing behavior

Describe expected behavior in code so future changes can be checked automatically.

Chapter goal: Describe expected behavior in code so future changes can be checked automatically.

Simple explanation

A test is an automatic checklist. It gives code an input, runs one behavior, and checks that the result is still correct.

In LUA, this chapter is about arranging input, running one behavior, and checking its observable result. Start with the idea above. Then connect each symbol to a value or action in the example.

Do not try to remember every symbol. First ask what data the program has, what it does with that data, and what result it creates. Technical words become easier when you connect them to those three questions.

Why this topic is important

Tests protect important behavior and give you confidence to change code you did not write. In LUA, the syntax may look different from other languages, but the thinking skill transfers: name the data, choose the right operation, and make the next step obvious.

When to use it

Test calculations, validation, state changes, parsing, permissions, widgets, components, and API boundaries.

Example code

local function add(a, b)
  return a + b
end
assert(add(2, 3) == 5, "add should return 5")

Line-by-line explanation

• local function add(a, b) — This defines a reusable function. Its name describes the job that other code can call.
• return a + b — This sends a result back to the code that called the function. Returning is different from printing.
• end — This line supports one focused piece of application logic. Read it together with the block directly around it.
• assert(add(2, 3) == 5, "add should return 5") — This sends a result back to the code that called the function. Returning is different from printing.

What the output means

The test reports success when the function returns the expected result.

The output is evidence that the program followed the instructions. If your result is different, read from the first line and write down how each value changes. That is debugging, not failure.

Mistake example

local function add(a, b)
  return a + b
end
assert(add(2, 3) == 6, "add should return 5")

The test expects the wrong result, so correct application behavior is reported as a failure.

Fixed version

local function add(a, b)
  return a + b
end
assert(add(2, 3) == 5, "add should return 5")

The corrected test checks the real expected behavior.

Common mistakes

• Testing private implementation details.
• Writing tests without meaningful failure messages.
• Mocking so much that no real behavior remains.

Warning: Change one part at a time. If you change many lines together, it becomes harder to learn which change caused the result.

Real use cases

• Verify a score calculation.
• Check invalid login input.
• Prevent a permissions regression.

Practice exercise

1. Write a success test.
2. Write an edge-case test.
3. Change the implementation without changing the expected behavior.

Tip: If the exercise feels too large, complete only steps 1 to 3. Small working code teaches more than a large unfinished project.

Mini quiz

1. What behavior is the test protecting?
2. What edge case is missing?
3. Should a test depend on private implementation details?

How to read AI-generated code

Do not copy AI code first. Read it like a detective. Find the data, follow the changes, and locate the final output. Ask AI to explain a line only after you have made your own guess.

• What data goes in?
• What values are stored?
• What calculation or decision happens?
• What is printed, displayed, saved, or returned?
• What can go wrong?
• Can you rename one value and still explain the code?

RedM safety check

RegisterCommand creates a named command. Its callback receives source (who triggered it) and args (the words after the command). Client code handles the local player's screen and input. Server code owns trusted game state. Never trust prices, rewards, permissions, or item counts sent by a client; check them again on the server.

Before you move on

• I can explain this topic in my own words.
• I can read the small example without AI.
• I can change the example and predict the new result.
• I can find and fix one simple mistake.
• I can name one real project that uses this idea.

Next topic

Next, learn security foundations. Before opening it, explain this chapter out loud in under one minute.