Floci service #
Run Floci as a background test dependency using FluentCI's native workspace service manager. Typed PureScript Wasm component; requires FluentCI v0.17.4+.
fluentci run floci start --version latest
fluentci run floci status
fluentci run floci logs --tail 50 --follow true
fluentci run floci restart
fluentci run floci stop
Default profile #
- Image:
floci/floci:latest; override the tag with--version, or supply--imageinstead. - Primary port:
4566; exposed ports:4566. - Readiness: http
/_localstack/health; deadline180000ms.
In-memory AWS API emulator. Docker-backed Lambda/ECS features require an explicit Docker socket mount; it is not mounted by default. The primary host port defaults to 4566; --port selects another explicit port and configures FLOCI_BASE_URL so returned AWS resource URLs use the reachable endpoint.
Test configuration #
FLOCI_STORAGE_MODE=memory.
These are disposable CI defaults. Supply application-specific configuration with
--env 'KEY=value,OTHER=value'; credentials in service definitions are not a secret store.
Use --ports 'HOST:CONTAINER,CONTAINER', --volumes 'test-data:/data,/host/config:/config:ro',
and --command 'program,arg1,arg2' for native overrides. Lists are comma-separated,
trimmed, validated, and passed as literal tokens. CSV quotes preserve embedded commas.
No shell expansion or JSON object arguments are used.
Start is idempotent, waits for native readiness, and returns the actual loopback
endpoint plus every container/host port binding. Dynamic host ports may differ
from container ports: use returned bindings when constructing client URLs.
--project selects the same workspace for all lifecycle calls. Native recurring
health checks use the readiness probe unless --health-check false is supplied.
--startup-timeout-ms, --stop-timeout-ms, --restart-policy, --max-restarts,
--depends-on, --readiness-path, and --readiness-command customize lifecycle
behavior; see COMPONENT.md for the complete typed contract.
Interrupting followed logs leaves the service running. Stop targets this named service and its native dependents, removes its supervised container, and preserves explicitly mounted data. Always stop services in your pipeline's cleanup step. Docker must be available, locally or through the caller's Docker context.
Upstream configuration · Shared service behavior
Compose this module from code #
Requires FluentCI 0.17.6 or newer for generated pipeline bindings. From your caller module's directory, add the dependency:
fluentci add floci --path /path/to/fluentci-modules/services/floci
For a published module, use fluentci add @fluentci.io/floci@VERSION with an
available version. Commit the caller's manifest and lockfile. FluentCI generates
named bindings from the installed component's WIT; no handwritten FFI or CLI
subprocess is needed. Include generated source directories in the caller's SDK
project. The callee can use a different SDK from the caller.
Start floci for integration tests using floci/floci:latest. Return the allocated endpoint to the caller; use it when configuring your test client.
Replace the sample organization, paths and identifiers with your own. Configure credentials through your CI secret provider before running authenticated operations. Optional arguments use the callee's defaults, and public list fields use comma-separated strings. See COMPONENT.md for argument descriptions and return types.
These examples use the generated composition API and builder chaining in FluentCI 0.17.6; full cross-SDK compilation and execution coverage is still pending. See composition support and limitations.
For services, register stop with the same project/name in failure-safe cleanup before running tests. A later ordinary stop step will be skipped when a preceding step fails. This short example starts the service using its default scoped name; it is not a complete service lifecycle. Elixir Flow does not yet offer failure-safe cleanup.
PureScript #
module Main where
import Prelude
import Effect (Effect)
import FluentCI.Flow as Flow
import FluentCI.Modules.Floci as Floci
run :: Effect String
run =
Flow.pipeline "floci-start"
# Flow.workdir "."
# Floci.start (Floci.startArgs)
# Flow.map (\result -> result.endpoint)
# Flow.run
Gleam #
import fluentci/flow
import fluentci_modules/floci
pub fn run() -> String {
flow.pipeline("floci-start")
|> flow.workdir(".")
|> floci.start(floci.start_args())
|> flow.map(fn(result) { result.endpoint })
|> flow.run
}
Use Gleam's JavaScript target for the Wasm guest. BEAM escripts used for repository automation are separate from component guests.
Elixir #
defmodule Main do
use FluentCI.Plugin
alias FluentCI.Flow
alias FluentCI.Modules.Floci
defplugin run do
Flow.pipeline("floci-start")
|> Flow.workdir(".")
|> Floci.start(%{})
|> Flow.stdout()
end
end
Elixir compiles this sequence to Rust/Wasm. Its initial Flow API does not yet provide the typed result callbacks or cleanup combinators of the other examples.
ClojureScript #
(ns main.plugin
(:require [fluentci.flow :as flow]
[fluentci-modules.floci :as floci]))
(defn run []
(-> (flow/pipeline "floci-start")
(flow/workdir ".")
(floci/start {})
flow/run!))
ReScript #
let run = (): string =>
Flow.pipeline("floci-start")
->Flow.workdir(".")
->FluentciModulesFloci.start(FluentciModulesFloci.startArgs)
->Flow.map(result => result.endpoint)
->Flow.run
Python #
from fluentci.flow import pipeline
from fluentci_modules import floci
def run() -> str:
return (
pipeline("floci-start")
.workdir(".")
.pipe(floci.start, {})
.map(lambda result: result.endpoint)
.run()
)
TypeScript #
import * as flow from "./fluentci_modules/flow";
import * as floci from "./fluentci_modules/floci/index";
export function run(): string {
return flow.pipeline("floci-start")
.workdir(".")
.pipe(floci.start, {})
.map(result => result.endpoint)
.run();
}
Python and TypeScript use FluentCI builder chains: .pipe(module.function, args)
composes generated module functions with .workdir, .env, and .exec.
Functions return a pipeline carrying their typed result. Use a generated result
callback (With/_with, or a callback argument in TypeScript/Python) when a later
module needs a preceding result; use Flow's map operation to select a result field.
Execution begins at run (or the Elixir plugin terminal), in declared order.
Exported functions #
| Function | Purpose |
|---|---|
start |
Start an idempotent background service through FluentCI’s native workspace service manager and wait for readiness. |
stop |
Stop only this named service through the native manager; preserve explicitly mounted data. Native dependents are stopped too. |
restart |
Restart the existing native service definition and wait for readiness. |
status |
Return the service’s native lifecycle state and actual loopback port bindings. |
logs |
Read native service logs; optionally follow new output until interrupted, without starting or stopping a service. |