blob: 8f410cfa6dc7226edde66fb6af252caf79813461 [file] [log] [blame]
/*
* Copyright (c) 2018 - present. Boling Consulting Solutions (bcsw.net)
* Copyright 2020-present Open Networking Foundation
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package meframe_test
import (
"github.com/google/gopacket"
. "github.com/opencord/omci-lib-go"
me "github.com/opencord/omci-lib-go/generated"
"github.com/opencord/omci-lib-go/meframe"
"github.com/stretchr/testify/assert"
"math/rand"
"testing"
)
func testGetAllAlarmsRequestTypeMeFrame(t *testing.T, managedEntity *me.ManagedEntity, messageSet DeviceIdent) {
params := me.ParamData{
EntityID: uint16(0),
}
// Create the managed instance
meInstance, err := me.NewManagedEntity(managedEntity.GetManagedEntityDefinition(), params)
assert.NotNil(t, err)
assert.Equal(t, err.StatusCode(), me.Success)
tid := uint16(rand.Int31n(0xFFFE) + 1) // [1, 0xFFFF]
mode := uint8(rand.Int31n(2)) // [0, 1]
frame, omciErr := meframe.GenFrame(meInstance, GetAllAlarmsRequestType, meframe.TransactionID(tid),
meframe.RetrievalMode(mode), meframe.FrameFormat(messageSet))
assert.NotNil(t, frame)
assert.NotZero(t, len(frame))
assert.Nil(t, omciErr)
///////////////////////////////////////////////////////////////////
// Now decode and compare
packet := gopacket.NewPacket(frame, LayerTypeOMCI, gopacket.NoCopy)
assert.NotNil(t, packet)
omciLayer := packet.Layer(LayerTypeOMCI)
assert.NotNil(t, omciLayer)
omciObj, omciOk := omciLayer.(*OMCI)
assert.NotNil(t, omciObj)
assert.True(t, omciOk)
assert.Equal(t, tid, omciObj.TransactionID)
assert.Equal(t, GetAllAlarmsRequestType, omciObj.MessageType)
assert.Equal(t, messageSet, omciObj.DeviceIdentifier)
msgLayer := packet.Layer(LayerTypeGetAllAlarmsRequest)
assert.NotNil(t, msgLayer)
msgObj, msgOk := msgLayer.(*GetAllAlarmsRequest)
assert.NotNil(t, msgObj)
assert.True(t, msgOk)
assert.Equal(t, meInstance.GetClassID(), msgObj.EntityClass)
assert.Equal(t, meInstance.GetEntityID(), msgObj.EntityInstance)
assert.Equal(t, mode, msgObj.AlarmRetrievalMode)
}
func testGetAllAlarmsResponseTypeMeFrame(t *testing.T, managedEntity *me.ManagedEntity, messageSet DeviceIdent) {
params := me.ParamData{
EntityID: uint16(0),
}
// Create the managed instance
meInstance, err := me.NewManagedEntity(managedEntity.GetManagedEntityDefinition(), params)
assert.NotNil(t, err)
assert.Equal(t, err.StatusCode(), me.Success)
tid := uint16(rand.Int31n(0xFFFE) + 1) // [1, 0xFFFF]
numOfCommands := uint16(rand.Int31n(5)) // [0, 5)
frame, omciErr := meframe.GenFrame(meInstance, GetAllAlarmsResponseType, meframe.TransactionID(tid),
meframe.SequenceNumberCountOrSize(numOfCommands), meframe.FrameFormat(messageSet))
assert.NotNil(t, frame)
assert.NotZero(t, len(frame))
assert.Nil(t, omciErr)
///////////////////////////////////////////////////////////////////
// Now decode and compare
packet := gopacket.NewPacket(frame, LayerTypeOMCI, gopacket.NoCopy)
assert.NotNil(t, packet)
omciLayer := packet.Layer(LayerTypeOMCI)
assert.NotNil(t, omciLayer)
omciObj, omciOk := omciLayer.(*OMCI)
assert.NotNil(t, omciObj)
assert.True(t, omciOk)
assert.Equal(t, tid, omciObj.TransactionID)
assert.Equal(t, GetAllAlarmsResponseType, omciObj.MessageType)
assert.Equal(t, messageSet, omciObj.DeviceIdentifier)
msgLayer := packet.Layer(LayerTypeGetAllAlarmsResponse)
assert.NotNil(t, msgLayer)
msgObj, msgOk := msgLayer.(*GetAllAlarmsResponse)
assert.NotNil(t, msgObj)
assert.True(t, msgOk)
assert.Equal(t, meInstance.GetClassID(), msgObj.EntityClass)
assert.Equal(t, meInstance.GetEntityID(), msgObj.EntityInstance)
assert.Equal(t, numOfCommands, msgObj.NumberOfCommands)
}
func testGetAllAlarmsNextRequestTypeMeFrame(t *testing.T, managedEntity *me.ManagedEntity, messageSet DeviceIdent) {
params := me.ParamData{
EntityID: uint16(0),
}
// Create the managed instance
meInstance, err := me.NewManagedEntity(managedEntity.GetManagedEntityDefinition(), params)
assert.NotNil(t, err)
assert.Equal(t, err.StatusCode(), me.Success)
tid := uint16(rand.Int31n(0xFFFE) + 1) // [1, 0xFFFF]
sequenceNumber := uint16(rand.Int31n(5)) // [0, 5)
frame, omciErr := meframe.GenFrame(meInstance, GetAllAlarmsNextRequestType, meframe.TransactionID(tid),
meframe.SequenceNumberCountOrSize(sequenceNumber), meframe.FrameFormat(messageSet))
assert.NotNil(t, frame)
assert.NotZero(t, len(frame))
assert.Nil(t, omciErr)
///////////////////////////////////////////////////////////////////
// Now decode and compare
packet := gopacket.NewPacket(frame, LayerTypeOMCI, gopacket.NoCopy)
assert.NotNil(t, packet)
omciLayer := packet.Layer(LayerTypeOMCI)
assert.NotNil(t, omciLayer)
omciObj, omciOk := omciLayer.(*OMCI)
assert.NotNil(t, omciObj)
assert.True(t, omciOk)
assert.Equal(t, tid, omciObj.TransactionID)
assert.Equal(t, GetAllAlarmsNextRequestType, omciObj.MessageType)
assert.Equal(t, messageSet, omciObj.DeviceIdentifier)
msgLayer := packet.Layer(LayerTypeGetAllAlarmsNextRequest)
assert.NotNil(t, msgLayer)
msgObj, msgOk := msgLayer.(*GetAllAlarmsNextRequest)
assert.NotNil(t, msgObj)
assert.True(t, msgOk)
assert.Equal(t, meInstance.GetClassID(), msgObj.EntityClass)
assert.Equal(t, meInstance.GetEntityID(), msgObj.EntityInstance)
assert.Equal(t, sequenceNumber, msgObj.CommandSequenceNumber)
}
func testGetAllAlarmsNextResponseTypeMeFrame(t *testing.T, managedEntity *me.ManagedEntity, messageSet DeviceIdent) {
params := me.ParamData{
EntityID: uint16(0),
}
// Create the managed instance
meInstance, err := me.NewManagedEntity(managedEntity.GetManagedEntityDefinition(), params)
assert.NotNil(t, err)
assert.Equal(t, err.StatusCode(), me.Success)
tid := uint16(rand.Int31n(0xFFFE) + 1) // [1, 0xFFFF]
alarmInfo := meframe.AlarmOptions{
AlarmClassID: 123, // TODO: Real class here?
AlarmInstance: 456,
AlarmBitmap: make([]byte, 28),
}
// TODO: Allow a 1 to 28 octet array to be used and zero fill any remainder...
for octet := 0; octet < 28; octet++ {
alarmInfo.AlarmBitmap[octet] = uint8(rand.Intn(256))
}
frame, omciErr := meframe.GenFrame(meInstance, GetAllAlarmsNextResponseType, meframe.TransactionID(tid),
meframe.Alarm(alarmInfo), meframe.FrameFormat(messageSet))
assert.NotNil(t, frame)
assert.NotZero(t, len(frame))
assert.Nil(t, omciErr)
///////////////////////////////////////////////////////////////////
// Now decode and compare
packet := gopacket.NewPacket(frame, LayerTypeOMCI, gopacket.NoCopy)
assert.NotNil(t, packet)
omciLayer := packet.Layer(LayerTypeOMCI)
assert.NotNil(t, omciLayer)
omciObj, omciOk := omciLayer.(*OMCI)
assert.NotNil(t, omciObj)
assert.True(t, omciOk)
assert.Equal(t, tid, omciObj.TransactionID)
assert.Equal(t, GetAllAlarmsNextResponseType, omciObj.MessageType)
assert.Equal(t, messageSet, omciObj.DeviceIdentifier)
msgLayer := packet.Layer(LayerTypeGetAllAlarmsNextResponse)
assert.NotNil(t, msgLayer)
msgObj, msgOk := msgLayer.(*GetAllAlarmsNextResponse)
assert.NotNil(t, msgObj)
assert.True(t, msgOk)
assert.Equal(t, meInstance.GetClassID(), msgObj.EntityClass)
assert.Equal(t, meInstance.GetEntityID(), msgObj.EntityInstance)
assert.Equal(t, alarmInfo.AlarmClassID, msgObj.AlarmEntityClass)
assert.Equal(t, alarmInfo.AlarmInstance, msgObj.AlarmEntityInstance)
for octet := 0; octet < len(alarmInfo.AlarmBitmap); octet++ {
assert.Equal(t, alarmInfo.AlarmBitmap[octet], msgObj.AlarmBitMap[octet])
}
}
func testAlarmNotificationTypeMeFrame(t *testing.T, managedEntity *me.ManagedEntity, messageSet DeviceIdent) {
// TODO: Implement
}