AlienFruit.Otml.Configuration.Keyraft 1.3.0

OTML is an object tree model language. It is a language that describes a tree of objects, which is easily readable by both man and machine. It is abstract, flexible and simple, there is no data standardization and no arrays in it. OTML supports comments and stream processing. <br/><br/>

• Specification
• Parser C# implementation
• Serializer C# implementation
• Configuration C# implementation
• Keyraft secrets storage

OTML targets

• To be easily understandable to a man
• To be minimalistic: have a syntax consisting of a minimum set of rules
• To be as abstract and flexible as possible, allowing to describe as many different data structures as possible
• To support data stream processing
• To develop and change easily, have a version system
• Forget about it: {}, this: [] and this: () <br/>

OTML example:

@FooObject
	TemplateId : 252
	Amount : 226
	Comments : 
		string129
		string93
		string190
	CrDate : "2020-03-29T16:04:35.4042938"
	Deleted : True
	DistributorId : 191
	BusinessStatusId : 253
	IsEditOut : False
	OpDate : "2020-08-22T08:31:25.9223099"
	Outercode : Outercodestring48
	PDADocNum : 51
	Values : 
		@ItemValue
			AnswerDate : "2017-08-21T10:32:51.6801390"
			AnswerNumber : 15
			AnswerStr : AnswerStrstring229
			Id : 30
		@ItemValue
			AnswerDate : "2017-12-17T04:07:10.4458521"
			AnswerNumber : 178
			AnswerStr : AnswerStrstring69
			Id : 225
		@ItemValue
			AnswerDate : "2017-09-20T03:52:18.1241429"
			AnswerNumber : 222
			AnswerStr : AnswerStrstring145
			Id : 204
	MultilineStringValue : 
		"When an outburst occurs from gas very near the black hole," +
		"the ejected gas collides with material flowing away from the massive stars in winds," +
		"pushing this material backwards and causing it to glow in X-rays." +
		"When the outburst dies down the winds return to normal and the X-rays fade."

Serialization

The next class will be used in examples:

public class Foo
{
	public string Name { get; set; }
	public string StringValue { get; set; }
	public int IntValue { get; set; }
}

Serialization to string:

var fooClass = new Foo
{
	Name = "Name",
	StringValue =  "Value",
	IntValue = 123
};

var serializer = OtmlSerializer.Create();

string result = serializer.Serialize(fooClass);

Serialization to Stream:

var fooClass = new Foo
{
	Name = "Name",
	StringValue =  "Value",
	IntValue = 123
};

var serializer = OtmlSerializer.Create();

using (var stream = File.OpenWrite("C:\\result.otml"))
{
	serializer.Serialize(fooClass, stream);
}

Deserialization

Deserialization from string:

var serializer = OtmlSerializer.Create();

var source =
	"@Foo\n" +
	"\tName: Name\n" +
	"\tStringValue : Value\n" +
	"\tIntValue : 123";

Foo result = serializer.Deserialize<Foo>(source);

Deserialization from Stream:

var source =
	"@Foo\n" +
	"\tName: Name\n" +
	"\tStringValue : Value\n" +
	"\tIntValue : 123";

using (var stream = new MemoryStream(Encoding.UTF8.GetBytes(source)))
{
	Foo result = serializer.Deserialize<Foo>(stream);
}

Configuration and secrets

Secrets don't belong in configuration files — they should never end up in a repository or be copied between environments. The AlienFruit.Otml.Configuration package loads an OTML file as an ordinary IConfiguration source — just like appsettings.json — and lets you reference a secret storage directly in the file:

@database
	password : {{secret:DB_PASSWORD}}
	connString : "Server=db;Password={{secret:DB_PASSWORD}};Pool=5"

When the value is read, the {{secret:DB_PASSWORD}} marker is replaced with the real secret from a connected storage — a self-hosted Keyraft server or environment variables. Connecting takes two lines:

// register the storage first, then add the file — the order matters
builder.Services.AddKeyraftSecretProvider(options => { /* BaseUrl, Token, Namespace */ });
builder.Configuration.AddOtmlConfigurationFile("settings.otml");

Reading is no different from ordinary configuration — a single value or a whole section via IOptions:

var password = configuration["database:password"]; // the secret comes from the storage

builder.Services.Configure<DatabaseOptions>(builder.Configuration.GetSection("database"));
// in the service constructor: IOptions<DatabaseOptions> → options.Value.Password

Worth knowing:

• sections and binding work exactly like with appsettings.json;
• storages are tried one after another, the first found value wins;
• if no storage contains the secret, reading fails with a clear SecretNotFoundException instead of silently passing an empty password.

Marker semantics, built-in storages and plugging in your own: Configuration C# implementation, Keyraft secrets storage.