gremlin-javascript/src/main/javascript/gremlin-javascript/test/unit/graphbinary/TraversalStrategySerializer-test.js

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.
 */

/**
 * @author Igor Ostapenko
 */

import { ser_title, cbuf_title } from './utils.js';
import assert from 'assert';
import { traversalStrategySerializer } from '../../../lib/structure/io/binary/GraphBinary.js';
import { Traverser, P } from '../../../lib/process/traversal.js';
import { ElementIdStrategy, OptionsStrategy, TraversalStrategy } from '../../../lib/process/traversal-strategy.js';

const { from, concat } = Buffer;

describe('GraphBinary.TraversalStrategySerializer', () => {

  const type_code =  from([0x29]);
  const value_flag = from([0x00]);

  const cases = [
    { v:undefined, fq:1, b:[0x29,0x01], },
    { v:undefined, fq:0, b:[0x00,0x00,0x00,0x00, 0x00,0x00,0x00,0x00] },
    { v:null,      fq:1, b:[0x29,0x01] },
    { v:null,      fq:0, b:[0x00,0x00,0x00,0x00, 0x00,0x00,0x00,0x00] },

    { v:new ElementIdStrategy(),
      b:[
        0x00,0x00,0x00,0x54, ...from('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.ElementIdStrategy'),
        0x00,0x00,0x00,0x00,
      ]
    },

    { v:new OptionsStrategy({ 'A': 1, 'B': 2 }),
      b:[
        0x00,0x00,0x00,0x52, ...from('org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.OptionsStrategy'),
        0x00,0x00,0x00,0x02,
        // 'A':1
        0x03,0x00, 0x00,0x00,0x00,0x01, 0x41,
        0x01,0x00, 0x00,0x00,0x00,0x01,
        // 'B':2
        0x03,0x00, 0x00,0x00,0x00,0x01, 0x42,
        0x01,0x00, 0x00,0x00,0x00,0x02,
      ]
    },
  ];

  describe('#serialize', () =>
    cases
    .forEach(({ v, fq, b }, i) => it(ser_title({i,v}), () => {
      b = from(b);

      // when fq is under control
      if (fq !== undefined) {
        assert.deepEqual( traversalStrategySerializer.serialize(v, fq), b );
        return;
      }

      // generic case
      assert.deepEqual( traversalStrategySerializer.serialize(v, true),  concat([type_code, value_flag, b]) );
      assert.deepEqual( traversalStrategySerializer.serialize(v, false), concat([                       b]) );
    }))
  );

  describe('#canBeUsedFor', () =>
    // most of the cases are implicitly tested via AnySerializer.serialize() tests
    [
      { v: null,                       e: false },
      { v: undefined,                  e: false },
      { v: {},                         e: false },
      { v: new Traverser(),          e: false },
      { v: new P(),                  e: false },
      { v: [],                         e: false },
      { v: [0],                        e: false },
      { v: [function(){}],             e: false },
      { v: function(){},               e: false },
      { v: new TraversalStrategy(), e: true  },
    ].forEach(({ v, e }, i) => it(cbuf_title({i,v}), () =>
      assert.strictEqual( traversalStrategySerializer.canBeUsedFor(v), e )
    ))
  );

});