tests/src/whisk/core/cli/test/SequenceMigrationTests.scala

/*
 * Copyright 2015-2016 IBM Corporation
 *
 * 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 whisk.core.cli.test

import java.util.Date

import scala.concurrent.duration.DurationInt
import scala.language.postfixOps

import org.junit.runner.RunWith
import org.scalatest.BeforeAndAfter
import org.scalatest.junit.JUnitRunner

import common.StreamLogging
import common.TestHelpers
import common.TestUtils
import common.Wsk
import common.WskAdmin
import common.WskProps
import common.WskTestHelpers
import spray.json._
import spray.json.DefaultJsonProtocol.StringJsonFormat
import spray.testkit.ScalatestRouteTest
import whisk.core.WhiskConfig
import whisk.core.database.test.DbUtils
import whisk.core.entity._

/**
 * Tests that "old-style" sequences can be invoked
 */

@RunWith(classOf[JUnitRunner])
class SequenceMigrationTests
    extends TestHelpers
    with BeforeAndAfter
    with DbUtils
    with ScalatestRouteTest
    with WskTestHelpers
    with StreamLogging {

    implicit val actorSystem = system

    implicit val wskprops = WskProps()
    val wsk = new Wsk
    val whiskConfig = new WhiskConfig(WhiskEntityStore.requiredProperties)
    // handle on the entity datastore
    val entityStore = WhiskEntityStore.datastore(whiskConfig)
    val (user, namespace) = WskAdmin.getUser(wskprops.authKey)
    val allowedActionDuration = 120 seconds

    behavior of "Sequence Migration"

    it should "check default namespace '_' is preserved in WhiskAction of old style sequence" in {
        // read json file and add the appropriate namespace
        val seqJsonFile = "seq_type_2.json"
        val jsonFile = TestUtils.getTestActionFilename(seqJsonFile)
        val source = scala.io.Source.fromFile(jsonFile)
        val jsonString = try source.mkString finally source.close()
        val entityJson = jsonString.parseJson.asJsObject
        // add default namespace (i.e., user) to the json object
        val entityJsonWithNamespace = JsObject(entityJson.fields + ("namespace" -> JsString(namespace)))
        val wskEntity = entityJsonWithNamespace.convertTo[WhiskAction]
        wskEntity.exec match {
            case SequenceExec(components) =>
                // check '_' is preserved
                components.size shouldBe 2
                assert(components.forall { _.path.namespace.contains('_') }, "default namespace lost")
            case _ => assert(false)
        }
    }

    it should "invoke an old-style (kind sequence) sequence and get the result" in {
        val seqName = "seq_type_2"
        testOldStyleSequence(seqName, s"$seqName.json")
    }

    it should "not display code from an old sequence on action get" in {
        // install sequence in db
        val seqName = "seq_type_2"
        installActionInDb(s"$seqName.json")
        val stdout = wsk.action.get(seqName).stdout
        stdout.contains("code") shouldBe false
    }

    /**
     * helper function that tests old style sequence based on two actions echo and word_count
     * @param seqName the name of the sequence
     * @param seqFileName the name of the json file that contains the whisk action associated with the sequence
     */
    private def testOldStyleSequence(seqName: String, seqFileName: String) = {
        // create entities to insert in the entity store
        val echo = "echo.json"
        val wc = "word_count.json"
        val entities = Seq(echo, wc, seqFileName)
        for (entity <- entities) {
            installActionInDb(entity)
        }
        // invoke sequence
        val now = "it is now " + new Date()
        val run = wsk.action.invoke(seqName, Map("payload" -> now.mkString("\n").toJson))
        withActivation(wsk.activation, run, totalWait = allowedActionDuration) {
            activation =>
                val result = activation.response.result.get
                result.fields.get("count") shouldBe Some(JsNumber(now.split(" ").size))
        }
    }

    /**
     * helper function that takes a json file containing a whisk action (minus the namespace), adds namespace and installs in db
     */
    private def installActionInDb(actionJson: String) = {
        // read json file and add the appropriate namespace
        val jsonFile = TestUtils.getTestActionFilename(actionJson)
        val source = scala.io.Source.fromFile(jsonFile)
        val jsonString = try source.mkString finally source.close()
        val entityJson = jsonString.parseJson.asJsObject
        // add default namespace (i.e., user) to the json object
        val entityJsonWithNamespace = JsObject(entityJson.fields + ("namespace" -> JsString(namespace)))
        val wskEntity = entityJsonWithNamespace.convertTo[WhiskAction]
        implicit val tid = transid() // needed for put db below
        put(entityStore, wskEntity)
    }

    after {
        cleanup() // cleanup entities from db
    }
}