Skip to content

Commit

Permalink
refactor: remove out-dated samples and tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@danielpeintner
danielpeintner committed Sep 5, 2023
1 parent 76cf88c commit 1d9cbe0
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 2,112 deletions.
208 changes: 1 addition & 207 deletions packages/td-tools/test/AssetInterfaceDescriptionTest.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,213 +24,7 @@ import { ThingDescription } from "wot-typescript-definitions";
class AssetInterfaceDescriptionUtilTest {
private assetInterfaceDescriptionUtil = new AssetInterfaceDescriptionUtil();

@test.skip async "should correctly transform sample JSON AID_submodel HTTP v03 into a TD"() {
const modelFullString = await (await fs.readFile("test/util/AID_v03.json")).toString();
const modelFull = JSON.parse(modelFullString);
const modelSub = modelFull.submodels[1];

// submodel only + HTTP only
const td = this.assetInterfaceDescriptionUtil.transformSM2TD(
JSON.stringify(modelSub),
`{"title": "myTitle", "id": "urn:uuid:3deca264-4f90-4321-a5ea-f197e6a1c7cf"}`,
"HTTP"
);
const tdObj = JSON.parse(td);
// console.log(JSON.stringify(tdObj, null, 2));

// security
expect(tdObj).to.have.property("security").to.be.an("array").to.have.lengthOf(2);
expect(tdObj.securityDefinitions[tdObj.security[0]]).to.have.property("scheme").that.equals("basic");
expect(tdObj.securityDefinitions[tdObj.security[1]]).to.have.property("scheme").that.equals("oauth2");
// form entries limited to 1
expect(tdObj).to.have.property("properties").to.have.property("voltage");
expect(tdObj)
.to.have.property("properties")
.to.have.property("voltage")
.to.have.property("forms")
.to.be.an("array")
.to.have.lengthOf(1);
}

@test.skip async "should correctly transform sample JSON AID_v03 into a TD"() {
const modelAID = (await fs.readFile("test/util/AID_v03.json")).toString();
const td = this.assetInterfaceDescriptionUtil.transformAAS2TD(
modelAID,
`{"title": "myTitle", "id": "urn:uuid:3deca264-4f90-4321-a5ea-f197e6a1c7cf"}`
);

const tdObj = JSON.parse(td);
// console.log(JSON.stringify(tdObj, null, 2));
// TODO proper TD validation based on playground and/or JSON schema?
expect(tdObj).to.have.property("@context").that.equals("https://www.w3.org/2022/wot/td/v1.1");
expect(tdObj).to.have.property("title").that.equals("myTitle");
expect(tdObj).to.have.property("id").that.equals("urn:uuid:3deca264-4f90-4321-a5ea-f197e6a1c7cf");

expect(tdObj).to.have.property("security").to.be.an("array").to.have.lengthOf(5);
// Security Modbus
expect(tdObj.securityDefinitions[tdObj.security[0]]).to.have.property("scheme").that.equals("nosec");
// Security HTTP
expect(tdObj.securityDefinitions[tdObj.security[1]]).to.have.property("scheme").that.equals("basic");
expect(tdObj.securityDefinitions[tdObj.security[1]]).to.have.property("in").that.equals("header");
expect(tdObj.securityDefinitions[tdObj.security[2]]).to.have.property("scheme").that.equals("oauth2");
expect(tdObj.securityDefinitions[tdObj.security[2]]).to.have.property("flow").that.equals("client");
expect(tdObj.securityDefinitions[tdObj.security[2]])
.to.have.property("token")
.that.equals("https://example.com/token");
expect(tdObj.securityDefinitions[tdObj.security[2]]).to.have.property("scopes").that.equals("limited");
// Security OPC
expect(tdObj.securityDefinitions[tdObj.security[3]]).to.have.property("scheme").that.equals("uasec");
expect(tdObj.securityDefinitions[tdObj.security[3]])
.to.have.property("mode")
.that.equals('["none", "Sign", "Sign & Encrypt"]');
expect(tdObj.securityDefinitions[tdObj.security[3]])
.to.have.property("policy")
.that.equals('["none", "Basic128RSA15", "Basic256", "Basic256SHA256"]');
// Security MQTT
expect(tdObj.securityDefinitions[tdObj.security[4]]).to.have.property("scheme").that.equals("basic");
expect(tdObj.securityDefinitions[tdObj.security[4]]).to.have.property("in").that.equals("header");

expect(tdObj).to.have.property("properties").to.have.property("voltage");

// form entries
expect(tdObj)
.to.have.property("properties")
.to.have.property("voltage")
.to.have.property("forms")
.to.be.an("array")
.to.have.lengthOf(4);
// Modbus
expect(tdObj.properties.voltage.forms[0]).to.have.property("href").to.eql("modbus+tcp://192.168.1.187:502");
expect(tdObj.properties.voltage.forms[0])
.to.have.property("contentType")
.to.eql("application/octet-stream;byteSeq=BIG_ENDIAN");
expect(tdObj.properties.voltage.forms[0]).to.have.property("modbus:function").to.eql("readHoldingRegisters");
expect(tdObj.properties.voltage.forms[0]).to.have.property("modbus:address").to.eql("40001");
expect(tdObj.properties.voltage.forms[0]).to.have.property("modbus:quantity").to.eql("2"); // not a proper number in AID -> valueType *not* set
expect(tdObj.properties.voltage.forms[0]).to.have.property("security").to.deep.equal(["0_sc"]);
// HTTP
expect(tdObj.properties.voltage.forms[1])
.to.have.property("href")
.to.eql("https://192.168.1.187" + "/properties/voltage");
expect(tdObj.properties.voltage.forms[1]).to.have.property("htv:methodName").to.eql("GET");
expect(tdObj.properties.voltage.forms[1]).to.have.property("contentType").to.eql("text/xml"); // Note: "application/json" overridden locally
expect(tdObj.properties.voltage.forms[1]).to.have.property("subprotocol").to.eql("longpoll");
expect(tdObj.properties.voltage.forms[1]).to.have.property("security").to.deep.equal(["1_sc", "2_sc"]);
// OPC
expect(tdObj.properties.voltage.forms[2])
.to.have.property("href")
.to.eql("opc.tcp://192.168.1.187:4840/UAserver");
expect(tdObj.properties.voltage.forms[2]).to.have.property("contentType").to.eql("application/x.opcua.binary");
expect(tdObj.properties.voltage.forms[2]).to.have.property("ua:nodeId").to.eql('"ns=3;i=29"');
expect(tdObj.properties.voltage.forms[2])
.to.have.property("ua:expandedNodeId")
.to.eql(' "nsu=http://example.com/OPCUAServer/energy;i=29"');
expect(tdObj.properties.voltage.forms[2]).to.have.property("ua:method").to.eql("READ");
expect(tdObj.properties.voltage.forms[2]).to.have.property("security").to.deep.equal(["3_sc"]);
// MQTT
expect(tdObj.properties.voltage.forms[3]).to.have.property("href").to.eql("mqtt://test.mosquitto:1884");
expect(tdObj.properties.voltage.forms[3]).to.have.property("contentType").to.eql("application/json");
expect(tdObj.properties.voltage.forms[3])
.to.have.property("mqv:topic")
.to.eql("/devices/thing1/properties/voltage");
expect(tdObj.properties.voltage.forms[3]).to.have.property("mqv:controlPacket").to.eql("mqv:subscribe");
expect(tdObj.properties.voltage.forms[3]).to.have.property("mqv:retain").to.eql(true); // value is string but valueType states boolean
expect(tdObj.properties.voltage.forms[3]).to.have.property("security").to.deep.equal(["4_sc"]);

// filter HTTP submodel only
const td2 = this.assetInterfaceDescriptionUtil.transformAAS2TD(modelAID, `{"title": "myTitle"}`, "HTTP");
const td2Obj = JSON.parse(td2);
// security
expect(td2Obj).to.have.property("security").to.be.an("array").to.have.lengthOf(2);
expect(td2Obj.securityDefinitions[td2Obj.security[0]]).to.have.property("scheme").that.equals("basic");
expect(td2Obj.securityDefinitions[td2Obj.security[1]]).to.have.property("scheme").that.equals("oauth2");
// form entries limited to 1
expect(td2Obj).to.have.property("properties").to.have.property("voltage");
expect(td2Obj)
.to.have.property("properties")
.to.have.property("voltage")
.to.have.property("forms")
.to.be.an("array")
.to.have.lengthOf(1);

// filter Modbus and HTTP and submodel only
const td3 = this.assetInterfaceDescriptionUtil.transformAAS2TD(modelAID, `{"title": "myTitle"}`, "Modbus|HTTP");
const td3Obj = JSON.parse(td3);
// security
expect(td3Obj).to.have.property("security").to.be.an("array").to.have.lengthOf(3);
expect(td3Obj.securityDefinitions[td3Obj.security[0]]).to.have.property("scheme").that.equals("nosec");
expect(td3Obj.securityDefinitions[td3Obj.security[1]]).to.have.property("scheme").that.equals("basic");
expect(td3Obj.securityDefinitions[td3Obj.security[2]]).to.have.property("scheme").that.equals("oauth2");
// form entries limited to 2
expect(td3Obj).to.have.property("properties").to.have.property("voltage");
expect(td3Obj)
.to.have.property("properties")
.to.have.property("voltage")
.to.have.property("forms")
.to.be.an("array")
.to.have.lengthOf(2);
}

@test.skip async "should correctly transform sample JSON AID_v03 for counter into a TD"() {
const modelAID = (await fs.readFile("test/util/AID_v03_counter.json")).toString();
const td = this.assetInterfaceDescriptionUtil.transformAAS2TD(modelAID, `{"title": "counter"}`);

const tdObj = JSON.parse(td);
// console.log(JSON.stringify(tdObj, null, 2));
// TODO proper TD validation based on playground and/or JSON schema?
expect(tdObj).to.have.property("@context").that.equals("https://www.w3.org/2022/wot/td/v1.1");
expect(tdObj).to.have.property("title").that.equals("counter");

expect(tdObj).to.have.property("security").to.be.an("array").to.have.lengthOf(1);
expect(tdObj.securityDefinitions[tdObj.security[0]]).to.have.property("scheme").that.equals("nosec");

expect(tdObj).to.have.property("properties").to.have.property("count");
// to check if count properties has type element that is equals the value defined in AID->integer
expect(tdObj)
.to.have.property("properties")
.to.have.property("count")
.to.have.property("type")
.that.equals("integer");

// form entries
expect(tdObj)
.to.have.property("properties")
.to.have.property("count")
.to.have.property("forms")
.to.be.an("array")
.to.have.lengthOf(1);
// HTTP
expect(tdObj.properties.count.forms[0])
.to.have.property("href")
.to.eql("http://plugfest.thingweb.io:8083/counter" + "/properties/count");
expect(tdObj.properties.count.forms[0]).to.have.property("htv:methodName").to.eql("GET");
expect(tdObj.properties.count.forms[0]).to.have.property("contentType").to.eql("application/json");
// security not needed at form level in this case
expect(tdObj.properties.count.forms[0]).not.to.have.property("security");

// TODO actions and events for counter thing

// check RegEx capability with fully qualified submodel
const td2 = this.assetInterfaceDescriptionUtil.transformAAS2TD(
modelAID,
`{"title": "counter"}`,
"InterfaceHTTP"
);
const td2Obj = JSON.parse(td2);
expect(tdObj).to.deep.equal(td2Obj);

// check RegEx capability with search pattern for submodel
const td3 = this.assetInterfaceDescriptionUtil.transformAAS2TD(modelAID, `{"title": "counter"}`, "HTTP*");
const td3Obj = JSON.parse(td3);
expect(tdObj).to.deep.equal(td3Obj);

// check RegEx capability with fully unknown submodel
const td4 = this.assetInterfaceDescriptionUtil.transformAAS2TD(modelAID, `{"title": "counter"}`, "OPC*");
const td4Obj = JSON.parse(td4);
expect(td4Obj).to.not.have.property("properties");
}

@test async "should correctly transform counterHTTP_minimal into a TD"() {
@test async "should correctly transform counterHTTP into a TD"() {
const modelAID = (await fs.readFile("test/util/counterHTTP.json")).toString();
const td = this.assetInterfaceDescriptionUtil.transformAAS2TD(modelAID, `{"title": "counter"}`);

Expand Down
Binary file removed packages/td-tools/test/util/AID_v03.aasx
View file
Binary file not shown.
Loading

0 comments on commit 1d9cbe0

Please sign in to comment.