@getjones/test-infra 1.0.6 → 1.0.7

package/README.md

@@ -1,10 +1,264 @@
-# Extazy - Extremely Fast Test Setup & Preparation
+# Package Name: @getjones/test-infra
 
 ## Package Goal
+
 * Providing an easy and reusable interface for the backend system. Means, both by the OpenAPI, and the internal API.
 
-## Configuration
+## Interface
+
+### init
+
+* require the package with settled up configuration json
+
+```node
+const { internalAPI } = require('@getjones/test-infra')(conf);
+```
+
+* configuration example
+
+```node
+const dotenv = require('dotenv');
+
+dotenv.config();
+
+module.exports = {
+  backendUrl: process.env.BACKEND_URL,
+  credentials: {
+    superUser: process.env.CREDENTIALS_SUPER_USER,
+    superUserPassword: process.env.CREDENTIALS_SUPER_USER_PASSWORD,
+    strongPassword: process.env.CREDENTIALS_STRONG_PASSWORD,
+  },
+  accountCreationSecret: process.env.ACCOUNT_CREATION_SECRET,
+  environment: process.env.ENVIRONMENT,
+  email: process.env.EMAIL,
+};
+```
+
+### internalAPI
+
+* internalAPI contains the next services:
+    * auth
+    * accounts
+    * accountSettings
+    * projects
+
+```node
+const { auth, accounts, accountSettings, projects } = internalAPI;
+```
+
+### auth
+
+```node
+
+/**
+ *
+ * @param email (string)
+ * @param password (string)
+ * @return Auth cookie (string) with given email privileges.
+ */
+const getAuthCookie = async (email, password) => {
+};
+
+/**
+ *
+ * Required Configuration: {
+ * credentials.superUser,
+ * credentials.superUserPassword 
+ * }
+ * @return ICS cookie (String)
+ */
+const getIcsCookie = async () => {
+};
+```
+
+### accounts
+
+```node
+
+/**
+ *
+ * Required Configuration: {
+ *  accountCreationSecret: accountCreationSecret,
+ * }
+ *
+ * If you want to use default password so
+ * 'credentials.strongPassword' is needed
+ * to be a part of the configuration.
+ *
+ * @param email (string)
+ * @param accountName (string)
+ * @param context (string): Should contain ICS cookie
+ * @return Account (object)
+ */
+
+const createAccount = async (email, accountName, context,
+  password = credentials.strongPassword,
+  propertyType = PROPERTY_TYPE) => {
+};
+
+/**
+ *
+ * @param accountName (string)
+ * @param context (string): Should contains ICS cookie
+ * @return Account (object)
+ */
+const getAccount = async (accountName, context) => {
+};
+
+/**
+ *
+ * @param email (string)
+ * @param accountName (string)
+ * @param context (string): Should contain ICS cookie
+ * @param password (string)
+ * @return Account (object)
+ */
+const getOrCreateAccount = async (email, accountName, context, password = credentials.strongPassword) => {
+};
+
+/**
+ *
+ * @param accountName (string)
+ * @param context (string): Should contain ICS cookie
+ * @return Account ID (String)
+ */
+const getAccountId = async (accountName, context) => {
+};
+
+/**
+ *
+ * @param accountName (string)
+ * @param context (string): Should contains ICS cookie
+ * @return Http Response
+ */
+const deleteAccountByName = async (accountName, context) => {
+};
+
+/**
+ *
+ * @param accountId (string)
+ * @param context (string): Should contain ICS cookie
+ * @return Http Response
+ */
+const deleteAccountById = async (accountId, context) => {
+};
+```
+
+### accountSettings
+
+```node
+
+/**
+ *
+ * @param accountId (string)
+ * @param context (string): Should contain ICS cookie
+ * @return Account Settings (object)
+ */
+const getAccountSettings = async (accountId, context) => {
+};
+
+/**
+ *
+ * @param accountId (string)
+ * @param AccountSettings (object) Should Contain:
+ * isMultiPropertyTenants (boolean)
+ * isHighPriority (boolean)
+ * @param context (string): Should contain ICS cookie
+ * @return Http Response
+ */
+const updateAccountSettings = async (accountId, isMultiPropertyTenants, isHighPriority, context) => {
+};
+
+/**
+ * Summary: Change account settings to default
+ * Description:
+ * Update The Next Account Settings:
+ * isMultiPropertyTenants: false
+ * isHighPriority: false
+ * @param accountId (string)
+ * @param context (string): Should Contain ICS cookie
+ * @return Http Response
+ */
+const restoreAccountSettings = async (accountId, context) => {
+};
+
+```
+
+### projects
+
+```node
+
+/**
+ *
+ * @param accountName (string)
+ * @param context (string): Should contain cookie
+ * User's cookie that is related to this account or ICS cookie
+ * @return List of projects ([objects])
+ */
+const getProjectsByAccountName = async (accountName, context) => {
+};
+
+/**
+ *
+ * @param accountId (String)
+ * @param context (string): Should contain cookie
+ * User's cookie that is related to this account or ICS cookie
+ * @return List of projects ([objects])
+ */
+const getProjectsByAccountId = async (accountId, context) => {
+};
+
+/**
+ *
+ * @param accountId (string)
+ * @param projectName (string)
+ * @param context (string): Should contain cookie
+ * User's cookie that is related to this account or ICS cookie
+ * @return List of projects ([objects])
+ */
+const getProjectsByName = async (accountId, projectName, context) => {
+};
+
+/**
+ * Summary: Delete project by given details
+ * @param accountId (string)
+ * @param projectName (string)
+ * @param context (string): Should contain cookie
+ * User's cookie that is related to this account or ICS cookie
+ * @return List of projects ([objects])
+ */
+const deleteProjectByName = async (accountId, projectName, context) => {
+};
+
+/**
+ *
+ * @param project (object)
+ * @param accountName (string)
+ * @param context (string): Should contain cookie
+ * User's cookie that is related to this account or ICS cookie
+ * @return object contains generated projectId
+ */
 
+// Example for project input (Not all of them are required):
+const createProjectInput = {
+  'projectName': project.name,
+  'userId': '',
+  'projectDescription': project.description,
+  'address': project.address,
+  'projectNumber': project.number,
+  'projectStartDate': project.startDate,
+  'projectEndDate': project.endDate,
+  'city': project.city,
+  'state': project.state,
+  'zipCode': project.zipCode,
+  'companyNameForProject': project.companyNameForProject,
+  'certificateHolder': '',
+  'additionalInsured': '',
+  'tenantSolutionEnabled': '',
+  'onboardingEnabled': '',
+  'automaticRenewalEnabled': ''
+};
 
-* JSON object that includes configuration for api calls
-* Usage Example:https://bitbucket.org/mirudman/integration-tests/src/master/tests/src/emailEditor/draft.test.js
+const createProject = async (project, accountName, context) => {
+};
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -1,6 +1,6 @@
 const env = require('./env');
 
-const extazy = conf => {
+const init = conf => {
     env.init(conf);
 
     const auth = require('./internal-api/auth/auth.setup');
@@ -13,4 +13,4 @@ const extazy = conf => {
     return { internalAPI };
 };
 
-module.exports = extazy;
+module.exports = init;

package/src/internal-api/accounts/accounts.setup.js

@@ -68,25 +68,12 @@ const deleteAccountById = async (accountId, context) => {
     return accountsAPI.deleteAccount(accountId, context);
 };
 
-const updateAccountSettings = async (accountId, isMultiPropertyTenants, isHighPriority, context) => {
-    return accountsAPI.updateAccountSettings(accountId, { isMultiPropertyTenants, isHighPriority }, context);
-};
-
-const restoreAccountSettings = async (accountId, context) => {
-    return accountsAPI.updateAccountSettings(accountId, {
-        isMultiPropertyTenants: false,
-        isHighPriority: false
-    }, context);
-};
-
 module.exports = {
     getAccount,
     getOrCreateAccount,
     getAccountId,
     createAccount,
     deleteAccountByName,
-    deleteAccountById,
-    updateAccountSettings,
-    restoreAccountSettings
+    deleteAccountById
 };
 

package/src/internal-api/projects/projects.setup.js

@@ -12,7 +12,7 @@ const getProjectsByAccountId = async (accountId, context) => {
 
 const getProjectsByName = async (accountId, projectName, context) => {
     const projects = await getProjectsByAccountId(accountId, context);
-    const filteredProjects = projects.filter(project => project.projectName === projectName);
+    const filteredProjects = projects.filter(project => project.projectName === projectName) || [];
     return filteredProjects;
 };