Basic docs, test fixes

cloudfoundry · KlapTrap · Feb 19, 2019 · Jan 25, 2019 · Jan 25, 2019 · Jan 25, 2019
commit e9d53d9000958317c7882fa0b62649451a0bd720
diff --git a/docs/invite-user-guide.md b/docs/invite-user-guide.md
@@ -0,0 +1,46 @@
+# Invite User Guide
+
+Stratos provides a way for Cloud Foundry administrators, organization managers and space managers to invite users to an organization or space.
+
+During the invite process
+- A UAA and CF User will be created
+- Initial roles will be assigned. User will be added as an organization member and if applicable a pre-selected space role.
+- Users will be emailed a verification link. The link directs the user to a UAA site to set their password. 
+> Note - The user will not be able to log in without first setting their password, however CF admins, organization managers and space managers will still be able to set roles for the user
+
+## Set up
+There are number of set up steps to execute first.
+
+1) Supply SMTP server details for Jetstream to use to send out verification email. This can be done via the usual environment variable
+   approach or in the dev world in the config.properties file. The config settings, with example values, are as follows
+
+   ```
+   SMTP_FROM_ADDRESS=Stratos<test@test.com>
+   SMTP_HOST=127.0.0.1
+   SMTP_PASSWORD=
+   SMTP_PORT=1025
+   SMTP_USER=
+   TEMPLATE_DIR=./templates
+   ```
+   > Note - In the dev world use [tophfr/mailcatcher](https://hub.docker.com/r/tophfr/mailcatcher/) in place of an actual SMTP server
+   > (`docker run -d -p 1025:25 1080:80 tophfr/mailcatcher ` will bring up image, access the UI via `http://localhost:1080` and use the `config.properties` from above)
+
+2) Update the default email templates
+
+   Default templates are found, as per example configuration above, in `src/jetstream/templates`
+
+3) Create/Locate a UAA client with required scopes
+
+   Stratos uses a pre-configured UAA client to invite the UAA user and create the CF user. In needs both `scim.invite` and `// TODO: UPDATE`
+   To manually create such a user using the UAA CLI the following command can be used 
+   ```
+   uaac client add stratos-invite --scope scim.invite `// TODO: UPDATE` --authorized_grant_types client_credentials --authorities scim.invite -s password
+   ```
+   In the above example the client id is `stratos-invite` and client secret `password`
+
+4) In Stratos set uaa client
+   1) Navigate to the Cloud Foundry Summary page of the required CF
+   2) Use the `Configure` button in the `User Invitation Support` section
+   3) Supply the client id and secret and click `Configure`
+
+At this point CF administrators, organization managers and space managers should be able to invite a user via the Organization/Space Users table
diff --git a/...ponents/stacked-input-actions/stacked-input-action/stacked-input-action.component.spec.ts b/...ponents/stacked-input-actions/stacked-input-action/stacked-input-action.component.spec.ts
@@ -8,7 +8,7 @@ import {
 } from '../../../../test-framework/cloud-foundry-endpoint-service.helper';
 import { testSCFGuid } from '../../../../test-framework/store-test-helper';
 import { BooleanIndicatorComponent } from '../../boolean-indicator/boolean-indicator.component';
-import { StackedInputActionComponent } from './stacked-input-action.component';
+import { StackedInputActionComponent, StackedInputActionResult } from './stacked-input-action.component';
 
 describe('StackedInputActionComponent', () => {
   let component: StackedInputActionComponent;
@@ -29,7 +29,10 @@ describe('StackedInputActionComponent', () => {
   beforeEach(() => {
     fixture = TestBed.createComponent(StackedInputActionComponent);
     component = fixture.componentInstance;
-    component.stateIn$ = observableOf(null);
+    component.stateIn$ = observableOf({
+      key: 'string',
+      result: StackedInputActionResult.OTHER_VALUES_UPDATED
+    });
     fixture.detectChanges();
   });
 

diff --git a/...ntend/app/shared/components/stacked-input-actions/stacked-input-actions.component.spec.ts b/...ntend/app/shared/components/stacked-input-actions/stacked-input-actions.component.spec.ts
@@ -22,15 +22,15 @@ describe('StackedInputActionsComponent', () => {
       providers: [{
         provide: ActiveRouteCfOrgSpace,
         useFactory: () => new BaseCfOrgSpaceRouteMock(testSCFGuid)
-      }, ]
+      }]
     })
       .compileComponents();
   }));
 
   beforeEach(() => {
     fixture = TestBed.createComponent(StackedInputActionsComponent);
     component = fixture.componentInstance;
-    component.stateIn$ = observableOf(null);
+    component.stateIn$ = observableOf([]);
     fixture.detectChanges();
   });
 

diff --git a/src/jetstream/default.config.properties b/src/jetstream/default.config.properties
@@ -22,7 +22,7 @@ UI_PATH=../../dist
 
 
 # User Invites
-SMTP_FROM_ADDRESS=Stratos<test@test.com>
+SMTP_FROM_ADDRESS=Stratos<invite@stratos.com>
 SMTP_HOST=127.0.0.1
 SMTP_PASSWORD=
 SMTP_PORT=1025