Redfish 验证工具： Redfish Service Validator (OData CSDL)

这篇文章我去年就很想写了，因为当时身边有蛮多人对这个tool有些误解，对用来验证Redfish Schema来说它是个很好用的tool，快速又方便，现在社群也很活耀的持续开发，只是对第一次接触OData的人来说，可能会有点不知道怎么上手，但理解之后会发现其实它原理很简单的，然后如果还不认识OData的话可以先看 DMTF Redfish 介绍 ，里面有将官网连结都附上

Redfish Services validator 在 GitHub - DMTF/Redfish-Service-Validator的Readme中介绍是

Redfish Service Validator 是一个开源框架，用于检查启用了Redfish interface 的任何通用设备与DMTF 定义的Redfish schema 和specifications的一致性。该工具设计为与设备无关，并且完全基于旨在由设备支持的Redfish 规范驱动。

它是个检查Redfish Service 的Resource 是否符合DMTF定义的Schema 的工具，所以其实应该先了解CSDL Schema 怎么描述，所以这篇文章的目录如下

目录

OData CSDL（Common Schema Definition Language, 通用模式定义语言）

概述

CSDL format

Elements of CSDL namespaces

Qualified names

Entity type and complex type elements

Redfish Services validator

下载

不用安装，直接执行

常见被验出的问题

ERROR - Attributes: Property is null but is not Nullable

ERROR - XXX: Expected int, got type class 'str' (Type Error)

ERROR - Namespace of type xxx appears missing from SchemaXML xxx.xml, attempting highest type: #xxx.xxx.xxxERROR - New namespace: xxx.v1_0_2

---

*本篇文章使用到的Redfish Service 是用Redfish Mockup Server模拟的

*如果对Redfish schema 和specifications 的概念不太清楚的话，可参考如何描述Redfish 版本

OData CSDL（Common Schema Definition Language, 通用模式定义语言）

概述

OData CSDL 是定义在OData Version 4.0 Part 3: Common Schema Definition Language (CSDL) (oasis-open.org)中，Redfish 用它来描述resources 和resource collections的Schema

在service root URL(/redfish/v1) 后面加上$metadata可以看到Redfish Service的实体模型（entity model)，如下

[GET] /redfish/v1/$metadata
<?xml version="1.0" encoding="UTF-8"?>
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
    <edmx:Reference Uri="/redfish/v1/schema/AccountService_v1.xml">
        <edmx:Include Namespace="AccountService"/>
        <edmx:Include Namespace="AccountService.v1_0_0"/>
        <edmx:Include Namespace="AccountService.v1_0_2"/>
        <edmx:Include Namespace="AccountService.v1_0_3"/>
        <edmx:Include Namespace="AccountService.v1_0_4"/>
        <edmx:Include Namespace="AccountService.v1_0_5"/>
        <edmx:Include Namespace="AccountService.v1_0_6"/>
        <edmx:Include Namespace="AccountService.v1_0_7"/>
        <edmx:Include Namespace="AccountService.v1_0_8"/>
        <edmx:Include Namespace="AccountService.v1_0_9"/>

*metadata: a set of data that describes and gives information about other data.

metadata 原意是指描述数据的数据，在Redfish中就是用来描述Resource 的数据的数据，所以内容会包含该Resource 有哪些property，他们的type是int还是string，是不是required等

目前最新版的Redfish Services validator 是可以指定想要验证的schema folder，没有指定的话，就会从官网All Published Versions of DSP8010 | DMTF 抓最新版本 

 下载后就能在csdl folder中看到schema 文件了