feat(init): 🚧 turtle-tracking working

Author: ChristophLHR

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Busted
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v2
+
+    - name: get lua
+      uses: leafo/gh-actions-lua@v10
+      with: 
+        luaVersion: "5.1"
+
+    - name: get luarocks
+      uses: leafo/gh-actions-luarocks@v4
+      with: 
+        luaVersion: "5.1"
+
+    - name: get busted and luasocket
+      run: |
+        luarocks install busted
+        luarocks install luasocket
+        luarocks install luasec
+
+    - name: test
+      run: |
+        busted .

.gitignore

@@ -0,0 +1,3 @@
+/config
+/.vscode
+/computer

README.md

@@ -1 +1,21 @@
-# turtleemulator-lib
+# turtleEmulator-lib
+
+This Emulator is exclusively ment to enable testing CC code with a testingframework, outside MC and CraftOS.
+
+### WIP
+
+> This Libary is not finished at all at this point and <b><u> will not work yet.</b></u>
+> Should increase in scope incrementally. For now it (will) only keep track of position and turtle-direction
+
+### HOW TO USE
+
+```lua
+local turtleEmulator = require("<path>/turtleEmulator")
+
+local turtleOne = turtleEmulator:createTurtle()
+local turtleTwo = turtleEmulator:createTurtle()
+
+--currently this will only work with a self reference, will work on removing this neccessity
+-- one possibilty is a Proxy table in the turtleEmulator #todo
+
+```

tests/test_spec.lua

@@ -0,0 +1,254 @@
+---@class are
+---@field same function
+---@field equal function
+---@field equals function
+
+---@class is
+---@field truthy function
+---@field falsy function
+---@field not_true function
+---@field not_false function
+
+---@class has
+---@field error function
+---@field errors function
+
+---@class assert
+---@field are are
+---@field is is
+---@field are_not are
+---@field is_not is
+---@field has has
+---@field has_no has
+---@field True function
+---@field False function
+---@field has_error function
+---@field is_true function
+---@field equal function
+assert = assert
+
+-- functions provided by busted, only available in the global scope
+describe = describe
+it = it
+setup = setup
+before_each = before_each
+
+local turtleEmulator = require("../turtleEmulator")
+describe("Disabled Movement", function()
+    local turtle
+    setup(function()
+        turtle = turtleEmulator:createTurtle(turtleEmulator)
+        turtle.canMoveToCheck = function()
+            return false
+        end
+    end)
+    it("Can't move to forward", function()
+        local c, e = turtle:forward()
+        assert.is.falsy(c)
+        assert.are.equal("Can't move to forward", e)
+    end)
+    it("Can't move to back", function()
+        local c, e = turtle:back()
+        assert.is.falsy(c)
+        assert.are.equal("Can't move to back", e)
+    end)
+    it("Can't move to up", function()
+        local c, e = turtle:up()
+        assert.is.falsy(c)
+        assert.are.equal("Can't move to up", e)
+    end)
+    it("Can't move to down", function()
+        local c, e = turtle:down()
+        assert.is.falsy(c)
+        assert.are.equal("Can't move to down", e)
+    end)
+end)
+describe("Enabled Movement", function()
+    local turtle
+    setup(function()
+        turtle = turtleEmulator:createTurtle(turtleEmulator)
+        turtle["canMoveToCheck"] = function()
+            return true
+        end
+    end)
+    it("Can move to forward", function()
+        local c, e = turtle:forward()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+    end)
+    it("Can move to back", function()
+        local c, e = turtle:back()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+    end)
+    it("Can move to up", function()
+        local c, e = turtle:up()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+    end)
+    it("Can move to down", function()
+        local c, e = turtle:down()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+    end)
+end)
+describe("Track Movement", function()
+    local turtle
+    setup(function()
+        turtle = turtleEmulator:createTurtle(turtleEmulator)
+        turtle["canMoveToCheck"] = function()
+            return true
+        end
+    end)
+    before_each(function()
+        turtle.position.x = 0
+        turtle.position.z = 0
+        turtle.position.y = 0
+        turtle.facing = 0
+    end)
+    it("Move forward", function()
+        local c, e = turtle:forward()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+        assert.are.equal(1, turtle.position.x)
+        assert.are.equal(0, turtle.position.z)
+        assert.are.equal(0, turtle.position.y)
+    end)
+    it("Move back", function()
+        local c, e = turtle:back()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+        assert.are.equal(-1, turtle.position.x)
+        assert.are.equal(0, turtle.position.z)
+        assert.are.equal(0, turtle.position.y)
+    end)
+    it("Move up", function()
+        local c, e = turtle:up()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+        assert.are.equal(0, turtle.position.x)
+        assert.are.equal(0, turtle.position.z)
+        assert.are.equal(1, turtle.position.y)
+    end)
+    it("Move down", function()
+        local c, e = turtle:down()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+        assert.are.equal(0, turtle.position.x)
+        assert.are.equal(0, turtle.position.z)
+        assert.are.equal(-1, turtle.position.y)
+    end)
+end)
+describe("Track Facing Direction", function()
+    local turtle
+    setup(function()
+        turtle = turtleEmulator:createTurtle(turtleEmulator)
+        turtle["canMoveToCheck"] = function()
+            return true
+        end
+    end)
+    before_each(function()
+        turtle.position.x = 0
+        turtle.position.z = 0
+        turtle.position.y = 0
+        turtle.facing = 0
+    end)
+    it("Turn right", function()
+        turtle:turnRight()
+        assert.are.equal(1, turtle.facing)
+    end)
+    it("Turn left", function()
+        turtle:turnLeft()
+        assert.are.equal(3, turtle.facing)
+    end)
+    it("Turn right twice", function()
+        turtle:turnRight()
+        turtle:turnRight()
+        assert.are.equal(2, turtle.facing)
+    end)
+    it("Turn right four times", function()
+        turtle:turnRight()
+        turtle:turnRight()
+        turtle:turnRight()
+        turtle:turnRight()
+        assert.are.equal(0, turtle.facing)
+    end)
+end)
+describe("Complexer Movement", function()
+    local turtle
+    setup(function()
+        turtle = turtleEmulator:createTurtle()
+        turtle["canMoveToCheck"] = function()
+            return true
+        end
+    end)
+    before_each(function()
+        turtle.position.x = 0
+        turtle.position.z = 0
+        turtle.position.y = 0
+        turtle.facing = 0
+    end)
+    it("Move forward, turn right and turn forward", function()
+        assert.is_true(turtle:forward())
+        assert.is_true(turtle:turnRight())
+        local c, e = turtle:forward()
+        assert.is.truthy(c)
+        assert.are.equal(nil, e)
+        assert.are.equal(1, turtle.facing)
+        assert.are.equal(1, turtle.position.x)
+        assert.are.equal(1, turtle.position.z)
+        assert.are.equal(0, turtle.position.y)
+    end)
+    it("Move back, up, right, up, forward and then left", function()
+        assert.is_true(turtle:back())
+        assert.is_true(turtle:up())
+        assert.is_true(turtle:turnRight())
+        assert.is_true(turtle:up())
+        assert.is_true(turtle:forward())
+        assert.is_true(turtle:turnLeft())
+        assert.are.equal(0, turtle.facing)
+        assert.are.equal(-1, turtle.position.x)
+        assert.are.equal(1, turtle.position.z)
+        assert.are.equal(2, turtle.position.y)
+    end)
+end)
+
+describe("multiple Turtles", function()
+    local turtle1
+    local turtle2
+    setup(function()
+        turtle1 = turtleEmulator:createTurtle()
+        turtle2 = turtleEmulator:createTurtle()
+        turtle1["canMoveToCheck"] = function()
+            return true
+        end
+        turtle2["canMoveToCheck"] = function()
+            return true
+        end
+    end)
+    before_each(function()
+        turtle1.position.x = 0
+        turtle1.position.z = 0
+        turtle1.position.y = 0
+        turtle1.facing = 0
+        turtle2.position.x = 0
+        turtle2.position.z = 0
+        turtle2.position.y = 0
+        turtle2.facing = 0
+    end)
+
+    it("Move forward with both turtles and turn right with turtle2", function()
+        assert.is_true(turtle1:forward())
+        assert.is_true(turtle2:forward())
+        assert.is_true(turtle2:turnRight())
+        assert.is_true(turtle2:forward())
+        assert.are.equal(1, turtle1.position.x)
+        assert.are.equal(0, turtle1.position.z)
+        assert.are.equal(0, turtle1.position.y)
+        assert.are.equal(0, turtle1.facing)
+        assert.are.equal(1, turtle2.position.x)
+        assert.are.equal(1, turtle2.position.z)
+        assert.are.equal(0, turtle2.position.y)
+        assert.are.equal(1, turtle2.facing)
+    end)
+end)