Document toolboxDocument toolbox

Sanity suite

Owned by Sarabjeet Kaur
Last updated: Nov 16, 2023
2 min read

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Note

  • Starting version 2023.1, Sanity Suite employs a single folder rather than three to execute operations on all of the Entities that are deployed during its execution. Users should remove any folders with their names included in the below-mentioned list from previous executions before running Sanity Suite if present on the cluster. List of Folder that must be deleted if present: "Sanity_Cube_On_HCatalog, Sanity_Cube_On_HDFS, Sanity_Cube_ON_MultiFact, Sanity_DRD_ON_HCatalog, Sanity_DRD_ON_HDFS, Sanity_DRD_ON_MultiFact, Sanity_RF_ON_HCatalog, Sanity_RF_ON_HDFS, Sanity_RF_ON_MultiFact, Sanity_RF_ON_SQL"

  • From Kyvos 2023.2 onwards, at the start of Sanity Suite, a 'NOW' type schedule (set as default) is set for one hour using the REST API to keep the Kyvos cluster online with full (100%) Query Engine capacity. However, you can disable the 'NOW' type schedule by modifying the 'Is Cluster Scaling Enabled' property in the sanity.properties file and setting it to false.

The sanity suite is a small set of integration tests to check the activities after receiving the software build and to ensure that all the changes introduced are working as expected.

After cluster deployment, you can run the sanity test to check if all the activities (like creating a dataset and semantic model processing) for browsing semantic models in the Kyvos application are working fine.

Prerequisites

  • Create database kyvosrepo_$clustername if the KYVOS_QUERY_ANALYZER_DATABASE is not present in the olapengine.properties file.

  • Create database $value of KYVOS_QUERY_ANALYZER_DATABASE if KYVOS_QUERY_ANALYZER_DATABASE is present in the olapengine.properties file.

  • Ensure that the Sanity_table table must exist when you are creating a database. 
    NOTE: If AWS Glue is enabled, the Sanity_table table is not created for AWS cluster deployment. Similarly, if Dataproc Metastore is enabled, this table is not created for GCP cluster deployment. 

Table Syntax

Following are the different types of table syntax to be used in the database for cluster deployment.

Using Sanity Suite

After cluster deployment, you can run the Sanity Suite to check if all the activities (like creating a Datasets, Data Relationship Diagram, and Semantic model processing) for browsing semantic models in the Kyvos application are working fine.

For this, click cluster name > Utilities > Run Sanity Suite on the navigation pane. 
The Run Sanity Suite page is displayed. 

  • On the page, you can do the following: 

    • Provide your Kyvos application (Web portal) login credentials to run the sanity test.

    • In the summary section, click the Download Report button to download the latest available report.

    • Click the Cleanup button to clean the entities created while executing the Sanity Suite.

    • Click the Load More button to run the remaining entities. 

Copyright Kyvos, Inc. All rights reserved.