Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bca91d71e5 | ||
|
|
02473a2b61 | ||
|
|
8178918c6e | ||
|
|
314987ae43 | ||
|
|
3fd59120f5 | ||
|
|
ade821ff61 | ||
|
|
162ca55092 | ||
|
|
69d022c061 | ||
|
|
0385eadc08 | ||
|
|
81240dd80f | ||
|
|
c2ed6f1bcb | ||
|
|
db61c053b1 |
6
Makefile
6
Makefile
@@ -6,9 +6,7 @@ build_rev := "main"
|
||||
ifneq ($(wildcard .git),)
|
||||
build_rev := $(shell git rev-parse --short HEAD)
|
||||
endif
|
||||
|
||||
build_date := $(shell date -u '+%Y%m%d')
|
||||
version := $(build_date):$(build_rev)
|
||||
build_date := $(shell date -u '+%Y-%m-%dT%H:%M:%S')
|
||||
|
||||
setup:
|
||||
@go mod download
|
||||
@@ -24,7 +22,7 @@ test:
|
||||
|
||||
|
||||
build:
|
||||
@go build -ldflags "-X main.Version=$(version)" -o build/codapi -v cmd/main.go
|
||||
@go build -ldflags "-X main.commit=$(build_rev) -X main.date=$(build_date)" -o build/codapi -v cmd/main.go
|
||||
|
||||
run:
|
||||
@./build/codapi
|
||||
|
||||
14
README.md
14
README.md
@@ -1,8 +1,8 @@
|
||||
# Embeddable code playgrounds
|
||||
# Interactive code examples
|
||||
|
||||
_for education, documentation, and fun_ 🎉
|
||||
_for documentation, education and fun_ 🎉
|
||||
|
||||
Codapi is a platform for embedding interactive code snippets directly into your product documentation, online course, or blog post.
|
||||
Codapi is a platform for embedding interactive code snippets directly into your product documentation, online course or blog post.
|
||||
|
||||
```
|
||||
┌───────────────────────────────┐
|
||||
@@ -21,12 +21,12 @@ Codapi manages sandboxes (isolated execution environments) and provides an API t
|
||||
|
||||
Highlights:
|
||||
|
||||
- Custom sandboxes for any programming language, database, or software.
|
||||
- Available as a cloud service and as a self-hosted version.
|
||||
- Open source. Uses the permissive Apache-2.0 license.
|
||||
- Automatically converts static code examples into mini-playgrounds.
|
||||
- Lightweight and easy to integrate.
|
||||
- Sandboxes for any programming language, database, or software.
|
||||
- Open source. Uses the permissive Apache-2.0 license.
|
||||
|
||||
Learn more at [codapi.org](https://codapi.org/)
|
||||
For an introduction to Codapi, see this post: [Interactive code examples for fun and profit](https://antonz.org/code-examples/).
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@@ -13,11 +13,16 @@ import (
|
||||
"github.com/nalgeon/codapi/internal/server"
|
||||
)
|
||||
|
||||
var Version string = "main"
|
||||
// set by the build process
|
||||
var (
|
||||
version = "main"
|
||||
commit = "none"
|
||||
date = "unknown"
|
||||
)
|
||||
|
||||
// startServer starts the HTTP API sandbox server.
|
||||
func startServer(port int) *server.Server {
|
||||
logx.Log("codapi %s", Version)
|
||||
logx.Log("codapi %s, commit %s, built at %s", version, commit, date)
|
||||
logx.Log("listening on port %d...", port)
|
||||
router := server.NewRouter()
|
||||
srv := server.NewServer(port, router)
|
||||
|
||||
@@ -28,10 +28,10 @@ docker run hello-world
|
||||
|
||||
```sh
|
||||
cd /opt/codapi
|
||||
curl -L -O "https://github.com/nalgeon/codapi/releases/download/0.5.0/codapi_0.5.0_linux_amd64.tar.gz"
|
||||
tar xvzf codapi_0.5.0_linux_amd64.tar.gz
|
||||
curl -L -O "https://github.com/nalgeon/codapi/releases/download/0.6.0/codapi_0.6.0_linux_amd64.tar.gz"
|
||||
tar xvzf codapi_0.6.0_linux_amd64.tar.gz
|
||||
chmod +x codapi
|
||||
rm -f codapi_0.5.0_linux_amd64.tar.gz
|
||||
rm -f codapi_0.6.0_linux_amd64.tar.gz
|
||||
```
|
||||
|
||||
5. Build Docker images (as codapi):
|
||||
|
||||
@@ -96,6 +96,7 @@ type Command struct {
|
||||
// A Step describes a single step of a command.
|
||||
type Step struct {
|
||||
Box string `json:"box"`
|
||||
Version string `json:"version"`
|
||||
User string `json:"user"`
|
||||
Action string `json:"action"`
|
||||
Stdin bool `json:"stdin"`
|
||||
|
||||
@@ -8,7 +8,6 @@ import (
|
||||
"io"
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
@@ -42,7 +41,7 @@ func NewDocker(cfg *config.Config, sandbox, command string) Engine {
|
||||
// Exec executes the command and returns the output.
|
||||
func (e *Docker) Exec(req Request) Execution {
|
||||
// all steps operate in the same temp directory
|
||||
dir, err := os.MkdirTemp("", "")
|
||||
dir, err := fileio.MkdirTemp(0777)
|
||||
if err != nil {
|
||||
err = NewExecutionError("create temp dir", err)
|
||||
return Fail(req.ID, err)
|
||||
@@ -54,7 +53,10 @@ func (e *Docker) Exec(req Request) Execution {
|
||||
if e.cmd.Entry != "" {
|
||||
// write request files to the temp directory
|
||||
err = e.writeFiles(dir, req.Files)
|
||||
if err != nil {
|
||||
var argErr ArgumentError
|
||||
if errors.As(err, &argErr) {
|
||||
return Fail(req.ID, err)
|
||||
} else if err != nil {
|
||||
err = NewExecutionError("write files to temp dir", err)
|
||||
return Fail(req.ID, err)
|
||||
}
|
||||
@@ -62,7 +64,7 @@ func (e *Docker) Exec(req Request) Execution {
|
||||
|
||||
// initialization step
|
||||
if e.cmd.Before != nil {
|
||||
out := e.execStep(e.cmd.Before, req.ID, dir, nil)
|
||||
out := e.execStep(e.cmd.Before, req, dir, nil)
|
||||
if !out.OK {
|
||||
return out
|
||||
}
|
||||
@@ -70,14 +72,14 @@ func (e *Docker) Exec(req Request) Execution {
|
||||
|
||||
// the first step is required
|
||||
first, rest := e.cmd.Steps[0], e.cmd.Steps[1:]
|
||||
out := e.execStep(first, req.ID, dir, req.Files)
|
||||
out := e.execStep(first, req, dir, req.Files)
|
||||
|
||||
// the rest are optional
|
||||
if out.OK && len(rest) > 0 {
|
||||
// each step operates on the results of the previous one,
|
||||
// without using the source files - hence `nil` instead of `files`
|
||||
for _, step := range rest {
|
||||
out = e.execStep(step, req.ID, dir, nil)
|
||||
out = e.execStep(step, req, dir, nil)
|
||||
if !out.OK {
|
||||
break
|
||||
}
|
||||
@@ -86,7 +88,7 @@ func (e *Docker) Exec(req Request) Execution {
|
||||
|
||||
// cleanup step
|
||||
if e.cmd.After != nil {
|
||||
afterOut := e.execStep(e.cmd.After, req.ID, dir, nil)
|
||||
afterOut := e.execStep(e.cmd.After, req, dir, nil)
|
||||
if out.OK && !afterOut.OK {
|
||||
return afterOut
|
||||
}
|
||||
@@ -96,34 +98,67 @@ func (e *Docker) Exec(req Request) Execution {
|
||||
}
|
||||
|
||||
// execStep executes a step using the docker container.
|
||||
func (e *Docker) execStep(step *config.Step, reqID, dir string, files Files) Execution {
|
||||
box := e.cfg.Boxes[step.Box]
|
||||
err := e.copyFiles(box, dir)
|
||||
func (e *Docker) execStep(step *config.Step, req Request, dir string, files Files) Execution {
|
||||
box, err := e.getBox(step, req)
|
||||
if err != nil {
|
||||
err = NewExecutionError("copy files to temp dir", err)
|
||||
return Fail(reqID, err)
|
||||
return Fail(req.ID, err)
|
||||
}
|
||||
|
||||
stdout, stderr, err := e.exec(box, step, reqID, dir, files)
|
||||
err = e.copyFiles(box, dir)
|
||||
if err != nil {
|
||||
return Fail(reqID, err)
|
||||
err = NewExecutionError("copy files to temp dir", err)
|
||||
return Fail(req.ID, err)
|
||||
}
|
||||
|
||||
stdout, stderr, err := e.exec(box, step, req, dir, files)
|
||||
if err != nil {
|
||||
return Fail(req.ID, err)
|
||||
}
|
||||
|
||||
return Execution{
|
||||
ID: reqID,
|
||||
ID: req.ID,
|
||||
OK: true,
|
||||
Stdout: stdout,
|
||||
Stderr: stderr,
|
||||
}
|
||||
}
|
||||
|
||||
// getBox selects an appropriate box for the step (if any).
|
||||
func (e *Docker) getBox(step *config.Step, req Request) (*config.Box, error) {
|
||||
if step.Action == actionExec {
|
||||
// exec steps use existing instances
|
||||
// and do not spin up new boxes
|
||||
return nil, nil
|
||||
}
|
||||
var boxName string
|
||||
// If the version is set in the step config, use it.
|
||||
if step.Version != "" {
|
||||
if step.Version == "latest" {
|
||||
boxName = step.Box
|
||||
} else {
|
||||
boxName = step.Box + ":" + step.Version
|
||||
}
|
||||
} else if req.Version != "" {
|
||||
// If the version is set in the request, use it.
|
||||
boxName = step.Box + ":" + req.Version
|
||||
} else {
|
||||
// otherwise, use the latest version
|
||||
boxName = step.Box
|
||||
}
|
||||
box, found := e.cfg.Boxes[boxName]
|
||||
if !found {
|
||||
return nil, fmt.Errorf("unknown box %s", boxName)
|
||||
}
|
||||
return box, nil
|
||||
}
|
||||
|
||||
// copyFiles copies box files to the temporary directory.
|
||||
func (e *Docker) copyFiles(box *config.Box, dir string) error {
|
||||
if box == nil || len(box.Files) == 0 {
|
||||
return nil
|
||||
}
|
||||
for _, pattern := range box.Files {
|
||||
err := fileio.CopyFiles(pattern, dir)
|
||||
err := fileio.CopyFiles(pattern, dir, 0444)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -138,8 +173,13 @@ func (e *Docker) writeFiles(dir string, files Files) error {
|
||||
if name == "" {
|
||||
name = e.cmd.Entry
|
||||
}
|
||||
path := filepath.Join(dir, name)
|
||||
err = os.WriteFile(path, []byte(content), 0444)
|
||||
var path string
|
||||
path, err = fileio.JoinDir(dir, name)
|
||||
if err != nil {
|
||||
err = NewArgumentError(fmt.Sprintf("files[%s]", name), err)
|
||||
return false
|
||||
}
|
||||
err = fileio.WriteFile(path, content, 0444)
|
||||
return err == nil
|
||||
})
|
||||
return err
|
||||
@@ -147,18 +187,18 @@ func (e *Docker) writeFiles(dir string, files Files) error {
|
||||
|
||||
// exec executes the step in the docker container
|
||||
// using the files from in the temporary directory.
|
||||
func (e *Docker) exec(box *config.Box, step *config.Step, reqID, dir string, files Files) (stdout string, stderr string, err error) {
|
||||
func (e *Docker) exec(box *config.Box, step *config.Step, req Request, dir string, files Files) (stdout string, stderr string, err error) {
|
||||
// limit the stdout/stderr size
|
||||
prog := NewProgram(step.Timeout, int64(step.NOutput))
|
||||
args := e.buildArgs(box, step, reqID, dir)
|
||||
args := e.buildArgs(box, step, req, dir)
|
||||
|
||||
if step.Stdin {
|
||||
// pass files to container from stdin
|
||||
stdin := filesReader(files)
|
||||
stdout, stderr, err = prog.RunStdin(stdin, reqID, "docker", args...)
|
||||
stdout, stderr, err = prog.RunStdin(stdin, req.ID, "docker", args...)
|
||||
} else {
|
||||
// pass files to container from temp directory
|
||||
stdout, stderr, err = prog.Run(reqID, "docker", args...)
|
||||
stdout, stderr, err = prog.Run(req.ID, "docker", args...)
|
||||
}
|
||||
|
||||
if err == nil {
|
||||
@@ -172,11 +212,11 @@ func (e *Docker) exec(box *config.Box, step *config.Step, reqID, dir string, fil
|
||||
// inside the container is not related to the "docker run" process,
|
||||
// and will hang forever after the "docker run" process is killed
|
||||
go func() {
|
||||
err = dockerKill(reqID)
|
||||
err = dockerKill(req.ID)
|
||||
if err == nil {
|
||||
logx.Debug("%s: docker kill ok", reqID)
|
||||
logx.Debug("%s: docker kill ok", req.ID)
|
||||
} else {
|
||||
logx.Log("%s: docker kill failed: %v", reqID, err)
|
||||
logx.Log("%s: docker kill failed: %v", req.ID, err)
|
||||
}
|
||||
}()
|
||||
}
|
||||
@@ -202,10 +242,10 @@ func (e *Docker) exec(box *config.Box, step *config.Step, reqID, dir string, fil
|
||||
}
|
||||
|
||||
// buildArgs prepares the arguments for the `docker` command.
|
||||
func (e *Docker) buildArgs(box *config.Box, step *config.Step, name, dir string) []string {
|
||||
func (e *Docker) buildArgs(box *config.Box, step *config.Step, req Request, dir string) []string {
|
||||
var args []string
|
||||
if step.Action == actionRun {
|
||||
args = dockerRunArgs(box, step, name, dir)
|
||||
args = dockerRunArgs(box, step, req, dir)
|
||||
} else if step.Action == actionExec {
|
||||
args = dockerExecArgs(step)
|
||||
} else {
|
||||
@@ -213,17 +253,17 @@ func (e *Docker) buildArgs(box *config.Box, step *config.Step, name, dir string)
|
||||
args = []string{"version"}
|
||||
}
|
||||
|
||||
command := expandVars(step.Command, name)
|
||||
command := expandVars(step.Command, req.ID)
|
||||
args = append(args, command...)
|
||||
logx.Debug("%v", args)
|
||||
return args
|
||||
}
|
||||
|
||||
// buildArgs prepares the arguments for the `docker run` command.
|
||||
func dockerRunArgs(box *config.Box, step *config.Step, name, dir string) []string {
|
||||
func dockerRunArgs(box *config.Box, step *config.Step, req Request, dir string) []string {
|
||||
args := []string{
|
||||
actionRun, "--rm",
|
||||
"--name", name,
|
||||
"--name", req.ID,
|
||||
"--runtime", box.Runtime,
|
||||
"--cpus", strconv.Itoa(box.CPU),
|
||||
"--memory", fmt.Sprintf("%dm", box.Memory),
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package engine
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
@@ -11,8 +12,26 @@ import (
|
||||
|
||||
var dockerCfg = &config.Config{
|
||||
Boxes: map[string]*config.Box{
|
||||
"postgresql": {
|
||||
Image: "codapi/postgresql",
|
||||
"alpine": {
|
||||
Image: "codapi/alpine",
|
||||
Runtime: "runc",
|
||||
Host: config.Host{
|
||||
CPU: 1, Memory: 64, Network: "none",
|
||||
Volume: "%s:/sandbox:ro",
|
||||
NProc: 64,
|
||||
},
|
||||
},
|
||||
"go": {
|
||||
Image: "codapi/go",
|
||||
Runtime: "runc",
|
||||
Host: config.Host{
|
||||
CPU: 1, Memory: 64, Network: "none",
|
||||
Volume: "%s:/sandbox:ro",
|
||||
NProc: 64,
|
||||
},
|
||||
},
|
||||
"go:dev": {
|
||||
Image: "codapi/go:dev",
|
||||
Runtime: "runc",
|
||||
Host: config.Host{
|
||||
CPU: 1, Memory: 64, Network: "none",
|
||||
@@ -29,8 +48,35 @@ var dockerCfg = &config.Config{
|
||||
NProc: 64,
|
||||
},
|
||||
},
|
||||
"python:dev": {
|
||||
Image: "codapi/python:dev",
|
||||
Runtime: "runc",
|
||||
Host: config.Host{
|
||||
CPU: 1, Memory: 64, Network: "none",
|
||||
Volume: "%s:/sandbox:ro",
|
||||
NProc: 64,
|
||||
},
|
||||
},
|
||||
},
|
||||
Commands: map[string]config.SandboxCommands{
|
||||
"go": map[string]*config.Command{
|
||||
"run": {
|
||||
Engine: "docker",
|
||||
Steps: []*config.Step{
|
||||
{
|
||||
Box: "go", User: "sandbox", Action: "run",
|
||||
Command: []string{"go", "build"},
|
||||
NOutput: 4096,
|
||||
},
|
||||
{
|
||||
Box: "alpine", Version: "latest",
|
||||
User: "sandbox", Action: "run",
|
||||
Command: []string{"./main"},
|
||||
NOutput: 4096,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
"postgresql": map[string]*config.Command{
|
||||
"run": {
|
||||
Engine: "docker",
|
||||
@@ -75,9 +121,10 @@ func TestDockerRun(t *testing.T) {
|
||||
"docker run": {Stdout: "hello world", Stderr: "", Err: nil},
|
||||
}
|
||||
mem := execy.Mock(commands)
|
||||
engine := NewDocker(dockerCfg, "python", "run")
|
||||
|
||||
t.Run("success", func(t *testing.T) {
|
||||
mem.Clear()
|
||||
engine := NewDocker(dockerCfg, "python", "run")
|
||||
req := Request{
|
||||
ID: "http_42",
|
||||
Sandbox: "python",
|
||||
@@ -103,8 +150,111 @@ func TestDockerRun(t *testing.T) {
|
||||
if out.Err != nil {
|
||||
t.Errorf("Err: expected nil, got %v", out.Err)
|
||||
}
|
||||
mem.MustHave(t, "codapi/python")
|
||||
mem.MustHave(t, "python main.py")
|
||||
})
|
||||
|
||||
t.Run("latest version", func(t *testing.T) {
|
||||
mem.Clear()
|
||||
engine := NewDocker(dockerCfg, "python", "run")
|
||||
req := Request{
|
||||
ID: "http_42",
|
||||
Sandbox: "python",
|
||||
Command: "run",
|
||||
Files: map[string]string{
|
||||
"": "print('hello world')",
|
||||
},
|
||||
}
|
||||
out := engine.Exec(req)
|
||||
if !out.OK {
|
||||
t.Error("OK: expected true")
|
||||
}
|
||||
mem.MustHave(t, "codapi/python")
|
||||
})
|
||||
|
||||
t.Run("custom version", func(t *testing.T) {
|
||||
mem.Clear()
|
||||
engine := NewDocker(dockerCfg, "python", "run")
|
||||
req := Request{
|
||||
ID: "http_42",
|
||||
Sandbox: "python",
|
||||
Version: "dev",
|
||||
Command: "run",
|
||||
Files: map[string]string{
|
||||
"": "print('hello world')",
|
||||
},
|
||||
}
|
||||
out := engine.Exec(req)
|
||||
if !out.OK {
|
||||
t.Error("OK: expected true")
|
||||
}
|
||||
mem.MustHave(t, "codapi/python:dev")
|
||||
})
|
||||
|
||||
t.Run("step version", func(t *testing.T) {
|
||||
mem.Clear()
|
||||
engine := NewDocker(dockerCfg, "go", "run")
|
||||
req := Request{
|
||||
ID: "http_42",
|
||||
Sandbox: "go",
|
||||
Version: "dev",
|
||||
Command: "run",
|
||||
Files: map[string]string{
|
||||
"": "var n = 42",
|
||||
},
|
||||
}
|
||||
out := engine.Exec(req)
|
||||
if !out.OK {
|
||||
t.Error("OK: expected true")
|
||||
}
|
||||
mem.MustHave(t, "codapi/go:dev")
|
||||
mem.MustHave(t, "codapi/alpine")
|
||||
})
|
||||
|
||||
t.Run("unsupported version", func(t *testing.T) {
|
||||
mem.Clear()
|
||||
engine := NewDocker(dockerCfg, "python", "run")
|
||||
req := Request{
|
||||
ID: "http_42",
|
||||
Sandbox: "python",
|
||||
Version: "42",
|
||||
Command: "run",
|
||||
Files: map[string]string{
|
||||
"": "print('hello world')",
|
||||
},
|
||||
}
|
||||
out := engine.Exec(req)
|
||||
if out.OK {
|
||||
t.Error("OK: expected false")
|
||||
}
|
||||
want := "unknown box python:42"
|
||||
if out.Stderr != want {
|
||||
t.Errorf("Stderr: unexpected value: %s", out.Stderr)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("directory traversal attack", func(t *testing.T) {
|
||||
mem.Clear()
|
||||
const fileName = "../../opt/codapi/codapi"
|
||||
engine := NewDocker(dockerCfg, "python", "run")
|
||||
req := Request{
|
||||
ID: "http_42",
|
||||
Sandbox: "python",
|
||||
Command: "run",
|
||||
Files: map[string]string{
|
||||
"": "print('hello world')",
|
||||
fileName: "hehe",
|
||||
},
|
||||
}
|
||||
out := engine.Exec(req)
|
||||
if out.OK {
|
||||
t.Error("OK: expected false")
|
||||
}
|
||||
want := fmt.Sprintf("files[%s]: invalid name", fileName)
|
||||
if out.Stderr != want {
|
||||
t.Errorf("Stderr: unexpected value: %s", out.Stderr)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestDockerExec(t *testing.T) {
|
||||
|
||||
@@ -12,13 +12,18 @@ import (
|
||||
type Request struct {
|
||||
ID string `json:"id"`
|
||||
Sandbox string `json:"sandbox"`
|
||||
Version string `json:"version,omitempty"`
|
||||
Command string `json:"command"`
|
||||
Files Files `json:"files"`
|
||||
}
|
||||
|
||||
// GenerateID() sets a unique ID for the request.
|
||||
func (r *Request) GenerateID() {
|
||||
r.ID = fmt.Sprintf("%s_%s_%s", r.Sandbox, r.Command, stringx.RandString(8))
|
||||
if r.Version != "" {
|
||||
r.ID = fmt.Sprintf("%s.%s_%s_%s", r.Sandbox, r.Version, r.Command, stringx.RandString(8))
|
||||
} else {
|
||||
r.ID = fmt.Sprintf("%s_%s_%s", r.Sandbox, r.Command, stringx.RandString(8))
|
||||
}
|
||||
}
|
||||
|
||||
// An Execution is an output from the code execution engine.
|
||||
@@ -57,6 +62,25 @@ func (err ExecutionError) Unwrap() error {
|
||||
return err.inner
|
||||
}
|
||||
|
||||
// An ArgumentError is returned if code execution failed
|
||||
// due to the invalid value of the request agrument.
|
||||
type ArgumentError struct {
|
||||
name string
|
||||
reason error
|
||||
}
|
||||
|
||||
func NewArgumentError(name string, reason error) ArgumentError {
|
||||
return ArgumentError{name: name, reason: reason}
|
||||
}
|
||||
|
||||
func (err ArgumentError) Error() string {
|
||||
return err.name + ": " + err.reason.Error()
|
||||
}
|
||||
|
||||
func (err ArgumentError) Unwrap() error {
|
||||
return err.reason
|
||||
}
|
||||
|
||||
// Files are a collection of files to be executed by the engine.
|
||||
type Files map[string]string
|
||||
|
||||
|
||||
@@ -4,9 +4,34 @@ import (
|
||||
"errors"
|
||||
"reflect"
|
||||
"sort"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestGenerateID(t *testing.T) {
|
||||
t.Run("with version", func(t *testing.T) {
|
||||
req := Request{
|
||||
Sandbox: "python",
|
||||
Version: "dev",
|
||||
Command: "run",
|
||||
}
|
||||
req.GenerateID()
|
||||
if !strings.HasPrefix(req.ID, "python.dev_run_") {
|
||||
t.Errorf("ID: unexpected prefix %s", req.ID)
|
||||
}
|
||||
})
|
||||
t.Run("without version", func(t *testing.T) {
|
||||
req := Request{
|
||||
Sandbox: "python",
|
||||
Command: "run",
|
||||
}
|
||||
req.GenerateID()
|
||||
if !strings.HasPrefix(req.ID, "python_run_") {
|
||||
t.Errorf("ID: unexpected prefix %s", req.ID)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestExecutionError(t *testing.T) {
|
||||
inner := errors.New("inner error")
|
||||
err := NewExecutionError("failed", inner)
|
||||
|
||||
@@ -2,15 +2,19 @@
|
||||
package fileio
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"io"
|
||||
"io/fs"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// CopyFile copies all files matching the pattern
|
||||
// to the destination directory.
|
||||
func CopyFiles(pattern string, dstDir string) error {
|
||||
func CopyFiles(pattern string, dstDir string, perm fs.FileMode) error {
|
||||
matches, err := filepath.Glob(pattern)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -24,7 +28,7 @@ func CopyFiles(pattern string, dstDir string) error {
|
||||
defer src.Close()
|
||||
|
||||
dstFile := filepath.Join(dstDir, filepath.Base(match))
|
||||
dst, err := os.Create(dstFile)
|
||||
dst, err := os.OpenFile(dstFile, os.O_RDWR|os.O_CREATE|os.O_TRUNC, perm)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -52,3 +56,69 @@ func ReadJson[T any](path string) (T, error) {
|
||||
}
|
||||
return obj, err
|
||||
}
|
||||
|
||||
// WriteFile writes the file to disk.
|
||||
// The content can be text or binary (encoded as a data URL),
|
||||
// e.g. data:application/octet-stream;base64,MTIz
|
||||
func WriteFile(path, content string, perm fs.FileMode) (err error) {
|
||||
var data []byte
|
||||
if strings.HasPrefix(content, "data:") {
|
||||
// data-url encoded file
|
||||
_, encoded, found := strings.Cut(content, ",")
|
||||
if !found {
|
||||
return errors.New("invalid data-url encoding")
|
||||
}
|
||||
data, err = base64.StdEncoding.DecodeString(encoded)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
// text file
|
||||
data = []byte(content)
|
||||
}
|
||||
return os.WriteFile(path, data, perm)
|
||||
}
|
||||
|
||||
// JoinDir joins a directory path with a relative file path,
|
||||
// making sure that the resulting path is still inside the directory.
|
||||
// Returns an error otherwise.
|
||||
func JoinDir(dir string, name string) (string, error) {
|
||||
if dir == "" {
|
||||
return "", errors.New("invalid dir")
|
||||
}
|
||||
|
||||
cleanName := filepath.Clean(name)
|
||||
if cleanName == "" {
|
||||
return "", errors.New("invalid name")
|
||||
}
|
||||
if cleanName == "." || cleanName == "/" || filepath.IsAbs(cleanName) {
|
||||
return "", errors.New("invalid name")
|
||||
}
|
||||
|
||||
path := filepath.Join(dir, cleanName)
|
||||
|
||||
dirPrefix := filepath.Clean(dir)
|
||||
if dirPrefix != "/" {
|
||||
dirPrefix += string(os.PathSeparator)
|
||||
}
|
||||
if !strings.HasPrefix(path, dirPrefix) {
|
||||
return "", errors.New("invalid name")
|
||||
}
|
||||
|
||||
return path, nil
|
||||
}
|
||||
|
||||
// MkdirTemp creates a new temporary directory with given permissions
|
||||
// and returns the pathname of the new directory.
|
||||
func MkdirTemp(perm fs.FileMode) (string, error) {
|
||||
dir, err := os.MkdirTemp("", "")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
err = os.Chmod(dir, perm)
|
||||
if err != nil {
|
||||
os.Remove(dir)
|
||||
return "", err
|
||||
}
|
||||
return dir, nil
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package fileio
|
||||
|
||||
import (
|
||||
"io/fs"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"reflect"
|
||||
@@ -30,18 +31,22 @@ func TestCopyFiles(t *testing.T) {
|
||||
defer os.RemoveAll(dstDir)
|
||||
|
||||
// Call the CopyFiles function
|
||||
const perm = fs.FileMode(0444)
|
||||
pattern := filepath.Join(srcDir, "*.txt")
|
||||
err = CopyFiles(pattern, dstDir)
|
||||
err = CopyFiles(pattern, dstDir, perm)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Verify that the file was copied correctly
|
||||
dstFile := filepath.Join(dstDir, "source.txt")
|
||||
_, err = os.Stat(dstFile)
|
||||
fileInfo, err := os.Stat(dstFile)
|
||||
if err != nil {
|
||||
t.Fatalf("file not copied: %s", err)
|
||||
}
|
||||
if fileInfo.Mode() != perm {
|
||||
t.Errorf("unexpected file permissions: got %v, want %v", fileInfo.Mode(), perm)
|
||||
}
|
||||
|
||||
// Read the contents of the copied file
|
||||
data, err := os.ReadFile(dstFile)
|
||||
@@ -82,3 +87,205 @@ func TestReadJson(t *testing.T) {
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestWriteFile(t *testing.T) {
|
||||
dir, err := os.MkdirTemp("", "files")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(dir)
|
||||
|
||||
t.Run("text", func(t *testing.T) {
|
||||
path := filepath.Join(dir, "data.txt")
|
||||
err = WriteFile(path, "hello", 0444)
|
||||
if err != nil {
|
||||
t.Fatalf("expected nil err, got %v", err)
|
||||
}
|
||||
got, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("read file: expected nil err, got %v", err)
|
||||
}
|
||||
want := []byte("hello")
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("read file: expected %v, got %v", want, got)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("binary", func(t *testing.T) {
|
||||
path := filepath.Join(dir, "data.bin")
|
||||
err = WriteFile(path, "data:application/octet-stream;base64,MTIz", 0444)
|
||||
if err != nil {
|
||||
t.Fatalf("expected nil err, got %v", err)
|
||||
}
|
||||
got, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("read file: expected nil err, got %v", err)
|
||||
}
|
||||
want := []byte("123")
|
||||
if !reflect.DeepEqual(got, want) {
|
||||
t.Errorf("read file: expected %v, got %v", want, got)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("perm", func(t *testing.T) {
|
||||
const perm = 0444
|
||||
path := filepath.Join(dir, "perm.txt")
|
||||
err = WriteFile(path, "hello", perm)
|
||||
if err != nil {
|
||||
t.Fatalf("expected nil err, got %v", err)
|
||||
}
|
||||
fileInfo, err := os.Stat(path)
|
||||
if err != nil {
|
||||
t.Fatalf("file not created: %s", err)
|
||||
}
|
||||
if fileInfo.Mode().Perm() != perm {
|
||||
t.Errorf("unexpected file permissions: expected %o, got %o", perm, fileInfo.Mode().Perm())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("missing data-url separator", func(t *testing.T) {
|
||||
path := filepath.Join(dir, "data.bin")
|
||||
err = WriteFile(path, "data:application/octet-stream:MTIz", 0444)
|
||||
if err == nil {
|
||||
t.Fatal("expected error, got nil")
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("invalid binary value", func(t *testing.T) {
|
||||
path := filepath.Join(dir, "data.bin")
|
||||
err = WriteFile(path, "data:application/octet-stream;base64,12345", 0444)
|
||||
if err == nil {
|
||||
t.Fatal("expected error, got nil")
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestJoinDir(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
dir string
|
||||
filename string
|
||||
want string
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "regular join",
|
||||
dir: "/home/user",
|
||||
filename: "docs/report.txt",
|
||||
want: "/home/user/docs/report.txt",
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "join with dot",
|
||||
dir: "/home/user",
|
||||
filename: ".",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "join with absolute path",
|
||||
dir: "/home/user",
|
||||
filename: "/etc/passwd",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "join with parent directory",
|
||||
dir: "/home/user",
|
||||
filename: "../user2/docs/report.txt",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "empty directory",
|
||||
dir: "",
|
||||
filename: "report.txt",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "empty filename",
|
||||
dir: "/home/user",
|
||||
filename: "",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "directory with trailing slash",
|
||||
dir: "/home/user/",
|
||||
filename: "docs/report.txt",
|
||||
want: "/home/user/docs/report.txt",
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "filename with leading slash",
|
||||
dir: "/home/user",
|
||||
filename: "/docs/report.txt",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "root directory",
|
||||
dir: "/",
|
||||
filename: "report.txt",
|
||||
want: "/report.txt",
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "dot dot slash filename",
|
||||
dir: "/home/user",
|
||||
filename: "..",
|
||||
want: "",
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := JoinDir(tt.dir, tt.filename)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("JoinDir() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if got != tt.want {
|
||||
t.Errorf("JoinDir() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestMkdirTemp(t *testing.T) {
|
||||
t.Run("default permissions", func(t *testing.T) {
|
||||
const perm = 0755
|
||||
dir, err := MkdirTemp(perm)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.Remove(dir)
|
||||
|
||||
info, err := os.Stat(dir)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to stat temp directory: %v", err)
|
||||
}
|
||||
if info.Mode().Perm() != perm {
|
||||
t.Errorf("unexpected permissions: expected %o, got %o", perm, info.Mode().Perm())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("non-default permissions", func(t *testing.T) {
|
||||
const perm = 0777
|
||||
dir, err := MkdirTemp(perm)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create temp directory: %v", err)
|
||||
}
|
||||
defer os.Remove(dir)
|
||||
|
||||
info, err := os.Stat(dir)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to stat temp directory: %v", err)
|
||||
}
|
||||
if info.Mode().Perm() != perm {
|
||||
t.Errorf("unexpected permissions: expected %o, got %o", perm, info.Mode().Perm())
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@@ -53,9 +53,14 @@ func (m *Memory) MustNotHave(t *testing.T, msg string) {
|
||||
}
|
||||
}
|
||||
|
||||
// Clear cleares the memory.
|
||||
func (m *Memory) Clear() {
|
||||
m.Lines = []string{}
|
||||
}
|
||||
|
||||
// Print prints memory lines to stdout.
|
||||
func (m *Memory) Print() {
|
||||
for _, line := range m.Lines {
|
||||
fmt.Print(line)
|
||||
fmt.Println(line)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,7 +7,7 @@ import "net/http"
|
||||
func enableCORS(handler func(w http.ResponseWriter, r *http.Request)) func(w http.ResponseWriter, r *http.Request) {
|
||||
return func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("access-control-allow-origin", "*")
|
||||
w.Header().Set("access-control-allow-method", "post")
|
||||
w.Header().Set("access-control-allow-methods", "options, post")
|
||||
w.Header().Set("access-control-allow-headers", "authorization, content-type")
|
||||
w.Header().Set("access-control-max-age", "3600")
|
||||
if r.Method == http.MethodOptions {
|
||||
|
||||
@@ -31,8 +31,8 @@ func Test_enableCORS(t *testing.T) {
|
||||
if w.Header().Get("access-control-allow-origin") != "*" {
|
||||
t.Errorf("invalid access-control-allow-origin")
|
||||
}
|
||||
if w.Header().Get("access-control-allow-method") != "post" {
|
||||
t.Errorf("invalid access-control-allow-method")
|
||||
if w.Header().Get("access-control-allow-methods") != "options, post" {
|
||||
t.Errorf("invalid access-control-allow-methods")
|
||||
}
|
||||
if w.Header().Get("access-control-allow-headers") != "authorization, content-type" {
|
||||
t.Errorf("invalid access-control-allow-headers")
|
||||
|
||||
Reference in New Issue
Block a user