From 45a2a41fd719213775d4eb4da72b521029ddb61a Mon Sep 17 00:00:00 2001
From: nklincoln <nkl199@yahoo.co.uk>
Date: Wed, 7 Jun 2017 14:34:00 +0100
Subject: [PATCH 1/2] enable addition of README file via AddFile

---
 .../src/app/add-file/add-file.component.html  |   1 +
 .../app/add-file/add-file.component.spec.ts   |  32 +++-
 .../src/app/add-file/add-file.component.ts    |  14 +-
 .../replace-confirm.component.html            |   2 +-
 .../replace-confirm.component.spec.ts         |  14 +-
 .../replace-confirm.component.ts              |  16 +-
 .../src/app/editor/editor.component.spec.ts   | 141 +++++++++++++++++-
 .../src/app/editor/editor.component.ts        |  31 +++-
 .../src/app/import/import.component.spec.ts   |   2 +
 .../src/app/import/import.component.ts        |   5 +-
 .../src/app/services/client.service.spec.ts   |  23 +++
 .../src/app/services/client.service.ts        |  16 +-
 .../src/assets/svg/other/MD_File.svg          |   1 +
 13 files changed, 264 insertions(+), 34 deletions(-)
 create mode 100644 packages/composer-playground/src/assets/svg/other/MD_File.svg

diff --git a/packages/composer-playground/src/app/add-file/add-file.component.html b/packages/composer-playground/src/app/add-file/add-file.component.html
index b6c52c6d45..aec9039ef1 100644
--- a/packages/composer-playground/src/app/add-file/add-file.component.html
+++ b/packages/composer-playground/src/app/add-file/add-file.component.html
@@ -20,6 +20,7 @@ <h1>Add a file</h1>
           <svg class="ibm-icon" aria-hidden="true">
             <use xlink:href="#icon-JS_File" *ngIf="fileType==='js'"></use>
             <use xlink:href="#icon-CTO_File" *ngIf="fileType==='cto'"></use>
+            <use xlink:href="#icon-MD_File" *ngIf="fileType==='md'"></use>
           </svg>
           <div class="file-title">
             <div class="title">{{currentFileName}}</div>
diff --git a/packages/composer-playground/src/app/add-file/add-file.component.spec.ts b/packages/composer-playground/src/app/add-file/add-file.component.spec.ts
index 9a47107f95..75297acfc0 100644
--- a/packages/composer-playground/src/app/add-file/add-file.component.spec.ts
+++ b/packages/composer-playground/src/app/add-file/add-file.component.spec.ts
@@ -117,7 +117,7 @@ describe('AddFileComponent', () => {
     });
 
     describe('#fileAccepted', () => {
-        it('should call this.createModel', fakeAsync(() => {
+        it('should call this.createModel if model file detected', fakeAsync(() => {
             let b = new Blob(['/**CTO File*/'], {type: 'text/plain'});
             let file = new File([b], 'newfile.cto');
 
@@ -130,7 +130,7 @@ describe('AddFileComponent', () => {
             createMock.should.have.been.called;
         }));
 
-        it('should call this.createScript', fakeAsync(() => {
+        it('should call this.createScript if script file detected', fakeAsync(() => {
 
             let b = new Blob(['/**JS File*/'], {type: 'text/plain'});
             let file = new File([b], 'newfile.js');
@@ -144,6 +144,20 @@ describe('AddFileComponent', () => {
             createMock.should.have.been.called;
         }));
 
+        it('should call this.createReadme if readme file detected', fakeAsync(() => {
+
+            let b = new Blob(['/**README File*/'], {type: 'text/plain'});
+            let file = new File([b], 'README.md');
+
+            let createMock = sandbox.stub(component, 'createReadme');
+            let dataBufferMock = sandbox.stub(component, 'getDataBuffer')
+            .returns(Promise.resolve('some data'));
+
+            component.fileAccepted(file);
+            tick();
+            createMock.should.have.been.called;
+        }));
+
         it('should call this.fileRejected when there is an error reading the file', fakeAsync(() => {
 
             let b = new Blob(['/**CTO File*/'], {type: 'text/plain'});
@@ -255,6 +269,20 @@ describe('AddFileComponent', () => {
         }));
     });
 
+    describe('#createModel', () => {
+        it('should establish a readme file', async(() => {
+            component.businessNetwork = mockBusinessNetwork;
+            let dataBuffer = new Buffer('/**README File**/ read all the things');
+
+            component.createReadme(dataBuffer);
+
+            component.fileType.should.equal('md');
+            component.currentFileName.should.equal('README.md');
+            component.currentFile.should.equal(dataBuffer.toString());
+        }));
+
+    });
+
     describe('#changeCurrentFileType', () => {
         it('should set current file to a script file, created by calling createScript with correct parameters', async(() => {
             let mockScript = sinon.createStubInstance(Script);
diff --git a/packages/composer-playground/src/app/add-file/add-file.component.ts b/packages/composer-playground/src/app/add-file/add-file.component.ts
index 48b4b2dafe..db522cb56e 100644
--- a/packages/composer-playground/src/app/add-file/add-file.component.ts
+++ b/packages/composer-playground/src/app/add-file/add-file.component.ts
@@ -21,7 +21,7 @@ export class AddFileComponent {
     expandInput: boolean = false;
 
     maxFileSize: number = 5242880;
-    supportedFileTypes: string[] = ['.js', '.cto'];
+    supportedFileTypes: string[] = ['.js', '.cto', '.md'];
 
     addModelNamespace: string = 'org.acme.model';
     addModelFileName: string = 'models/org.acme.model';
@@ -64,6 +64,10 @@ export class AddFileComponent {
                     this.expandInput = true;
                     this.createModel(file, data);
                     break;
+                case 'md':
+                    this.expandInput = true;
+                    this.createReadme(data);
+                    break;
                 default:
                     throw new Error('Unexpected File Type');
             }
@@ -92,7 +96,7 @@ export class AddFileComponent {
         this.fileType = 'js';
         let scriptManager = this.businessNetwork.getScriptManager();
         let filename = file.name ? 'lib/' + file.name : this.addScriptFileName;
-        this.currentFile = scriptManager.createScript('lib/' + file.name || this.addScriptFileName, 'JS', dataBuffer.toString());
+        this.currentFile = scriptManager.createScript(filename, 'JS', dataBuffer.toString());
         this.currentFileName = this.currentFile.getIdentifier();
     }
 
@@ -104,6 +108,12 @@ export class AddFileComponent {
         this.currentFileName = this.currentFile.getFileName();
     }
 
+    createReadme(dataBuffer) {
+        this.fileType = 'md';
+        this.currentFile = dataBuffer.toString();
+        this.currentFileName = 'README.md';
+    }
+
     fileRejected(reason: string) {
         this.alertService.errorStatus$.next(reason);
     }
diff --git a/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.html b/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.html
index b7401f76b9..c6e3be931d 100644
--- a/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.html
+++ b/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.html
@@ -3,7 +3,7 @@
     <svg class="ibm-icon" aria-hidden="true">
       <use xlink:href="#icon-warn_32"></use>
     </svg>
-    <h1>{{headerMessage}}</h1>
+    <h1>Current definition will be replaced</h1>
     <button class="icon modal-exit" (click)="activeModal.close(false)">
       <svg class="ibm-icon" aria-hidden="true">
         <use xlink:href="#icon-close_new"></use>
diff --git a/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.spec.ts b/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.spec.ts
index c55b0703e4..12612cb5e7 100644
--- a/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.spec.ts
+++ b/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.spec.ts
@@ -13,7 +13,7 @@ import * as chai from 'chai';
 
 let should = chai.should();
 
-describe('DeleteComponent', () => {
+describe('ReplaceComponent', () => {
     let component: ReplaceComponent;
     let fixture: ComponentFixture<ReplaceComponent>;
 
@@ -32,16 +32,4 @@ describe('DeleteComponent', () => {
         component.should.be.ok;
     });
 
-    describe('onInit', () => {
-
-        it('should set default messages', () => {
-
-            component['ngOnInit']();
-
-            component['headerMessage'].should.be.equal('Current definition will be replaced');
-            component['mainMessage'].should.be.equal('Your Business Network Definition currently in the Playground will be removed & replaced.');
-            component['supplementaryMessage'].should.be.equal('Please ensure that you have exported any current model files in the Playground.');
-        });
-
-    });
 });
diff --git a/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.ts b/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.ts
index 6ff40c8f1c..2e8bb8b45b 100644
--- a/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.ts
+++ b/packages/composer-playground/src/app/basic-modals/replace-confirm/replace-confirm.component.ts
@@ -1,4 +1,4 @@
-import { Component, Input, OnInit } from '@angular/core';
+import { Component, Input } from '@angular/core';
 import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap';
 
 @Component({
@@ -7,18 +7,12 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap';
     styleUrls: ['./replace-confirm.component.scss'.toString()]
 })
 
-export class ReplaceComponent implements OnInit {
+export class ReplaceComponent {
 
-    public headerMessage: string = null;
-    public mainMessage: string = null;
-    public supplementaryMessage: string = null;
+    @Input() headerMessage: string = null;
+    @Input() mainMessage: string = null;
+    @Input() supplementaryMessage: string = null;
 
     constructor(public activeModal: NgbActiveModal) {
     }
-
-    ngOnInit() {
-        this.headerMessage = 'Current definition will be replaced';
-        this.mainMessage = 'Your Business Network Definition currently in the Playground will be removed & replaced.';
-        this.supplementaryMessage = 'Please ensure that you have exported any current model files in the Playground.';
-    }
 }
diff --git a/packages/composer-playground/src/app/editor/editor.component.spec.ts b/packages/composer-playground/src/app/editor/editor.component.spec.ts
index 3ea5c69fff..477a9ac842 100644
--- a/packages/composer-playground/src/app/editor/editor.component.spec.ts
+++ b/packages/composer-playground/src/app/editor/editor.component.spec.ts
@@ -643,6 +643,111 @@ describe('EditorComponent', () => {
         });
     });
 
+    describe('addReadme', () => {
+        it('should not open confirm modal if no readme present', fakeAsync(() => {
+            let mockUpdateFiles = sinon.stub(component, 'updateFiles');
+            let mockSetCurrentFile = sinon.stub(component, 'setCurrentFile');
+            component['files'] = [{id: 'random'}, {id: 'script'}];
+
+            let b = new Blob(['/**README File*/'], {type: 'text/plain'});
+            let mockReadmeFile = new File([b], 'redme.md');
+
+            component.addReadme(mockReadmeFile);
+            tick();
+
+            mockModal.open.should.not.have.been.called;
+        }));
+
+        it('should create readme if no existing readme present', fakeAsync(() => {
+            let mockUpdateFiles = sinon.stub(component, 'updateFiles');
+            let mockSetCurrentFile = sinon.stub(component, 'setCurrentFile');
+
+            component['files'] = [{id: 'zero-index'}, {id: 'script'}];
+
+            let b = new Blob(['/**README File*/'], {type: 'text/plain'});
+            let mockReadmeFile = new File([b], 'readme.md');
+
+            component.addReadme(mockReadmeFile);
+
+            tick();
+
+            mockClientService.setBusinessNetworkReadme.should.have.been.calledWith(mockReadmeFile);
+            mockUpdateFiles.should.have.been.called;
+            mockSetCurrentFile.should.have.been.calledWith({id: 'zero-index'});
+            component['dirty'].should.be.equal(true);
+        }));
+
+        it('should open confirm modal if readme present and handle error', fakeAsync(() => {
+            let mockUpdateFiles = sinon.stub(component, 'updateFiles');
+            let mockSetCurrentFile = sinon.stub(component, 'setCurrentFile');
+            component['files'] = [{readme: true}, {id: 'script'}];
+
+            let b = new Blob(['/**README File*/'], {type: 'text/plain'});
+            let mockReadmeFile = new File([b], 'redme.md');
+
+            mockModal.open = sinon.stub().returns({
+                componentInstance: {},
+                result: Promise.reject('some error')
+            });
+
+            component.addReadme(mockReadmeFile);
+            tick();
+
+            mockModal.open.should.have.been.called;
+            mockAlertService.errorStatus$.next.should.have.been.calledWith('some error');
+            mockClientService.setBusinessNetworkReadme.should.not.have.been.called;
+            mockUpdateFiles.should.not.have.been.called;
+            mockSetCurrentFile.should.not.have.been.called;
+        }));
+
+        it('should handle confirm modal cancel', fakeAsync(() => {
+            let mockUpdateFiles = sinon.stub(component, 'updateFiles');
+            let mockSetCurrentFile = sinon.stub(component, 'setCurrentFile');
+            component['files'] = [{readme: true}, {id: 'script'}];
+
+            let b = new Blob(['/**README File*/'], {type: 'text/plain'});
+            let mockReadmeFile = new File([b], 'redme.md');
+
+            mockModal.open = sinon.stub().returns({
+                componentInstance: {},
+                result: Promise.reject(1)
+            });
+
+            component.addReadme(mockReadmeFile);
+            tick();
+
+            mockModal.open.should.have.been.called;
+            mockAlertService.errorStatus$.next.should.not.have.been.called;
+            mockClientService.setBusinessNetworkReadme.should.not.have.been.called;
+            mockUpdateFiles.should.not.have.been.called;
+            mockSetCurrentFile.should.not.have.been.called;
+        }));
+
+        it('should create readme on modal confirm', fakeAsync(() => {
+            let mockUpdateFiles = sinon.stub(component, 'updateFiles');
+            let mockSetCurrentFile = sinon.stub(component, 'setCurrentFile');
+            component['files'] = [{readme: true}, {id: 'script'}];
+
+            let b = new Blob(['/**README File*/'], {type: 'text/plain'});
+            let mockReadmeFile = new File([b], 'redme.md');
+
+            mockModal.open = sinon.stub().returns({
+                componentInstance: {},
+                result: Promise.resolve()
+            });
+
+            component.addReadme(mockReadmeFile);
+            tick();
+
+            mockModal.open.should.have.been.called;
+            mockAlertService.errorStatus$.next.should.not.have.been.called;
+            mockClientService.setBusinessNetworkReadme.should.have.been.called;
+            mockUpdateFiles.should.have.been.called;
+            mockSetCurrentFile.should.have.been.calledWith({readme: true});
+        }));
+
+    });
+
     describe('openImportModal', () => {
         it('should open the import modal', fakeAsync(() => {
             let mockUpdatePackage = sinon.stub(component, 'updatePackageInfo');
@@ -793,6 +898,7 @@ describe('EditorComponent', () => {
     describe('openAddFileModal', () => {
         let mockAddModel;
         let mockAddScript;
+        let mockAddReadme;
 
         beforeEach(() => {
             mockModal.open = sinon.stub().returns({
@@ -808,6 +914,7 @@ describe('EditorComponent', () => {
 
             mockAddModel = sinon.stub(component, 'addModelFile');
             mockAddScript = sinon.stub(component, 'addScriptFile');
+            mockAddReadme = sinon.stub(component, 'addReadme');
         });
 
         it('should open add file modal', fakeAsync(() => {
@@ -819,7 +926,23 @@ describe('EditorComponent', () => {
             mockAddModel.should.have.been.called;
         }));
 
-        it('should open add file script', fakeAsync(() => {
+        it('should open AddFileComponent modal and call addModelFile if model returned', fakeAsync(() => {
+            mockModal.open = sinon.stub().returns({
+                componentInstance: {
+                    businessNetwork: {}
+                },
+                result: Promise.resolve(mockModelFile)
+            });
+
+            component.openAddFileModal();
+
+            tick();
+
+            mockAddModel.should.have.been.called;
+            mockClientService.businessNetworkChanged$.next.should.have.been.calledWith(true);
+        }));
+
+        it('should open AddFileComponent modal and call addScriptFile if script returned', fakeAsync(() => {
             mockModal.open = sinon.stub().returns({
                 componentInstance: {
                     businessNetwork: {}
@@ -835,6 +958,22 @@ describe('EditorComponent', () => {
             mockClientService.businessNetworkChanged$.next.should.have.been.calledWith(true);
         }));
 
+        it('should open AddFileComponent modal and call addreadme if README returned', fakeAsync(() => {
+            mockModal.open = sinon.stub().returns({
+                componentInstance: {
+                    businessNetwork: {}
+                },
+                result: Promise.resolve({})
+            });
+
+            component.openAddFileModal();
+
+            tick();
+
+            mockAddReadme.should.have.been.called;
+            mockClientService.businessNetworkChanged$.next.should.have.been.calledWith(true);
+        }));
+
         it('should do nothing if no result', fakeAsync(() => {
             mockAddScript.reset;
             mockAddModel.reset;
diff --git a/packages/composer-playground/src/app/editor/editor.component.ts b/packages/composer-playground/src/app/editor/editor.component.ts
index da86c21850..766ca7d3e7 100644
--- a/packages/composer-playground/src/app/editor/editor.component.ts
+++ b/packages/composer-playground/src/app/editor/editor.component.ts
@@ -5,6 +5,7 @@ import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
 import { ImportComponent } from '../import/import.component';
 import { AddFileComponent } from '../add-file/add-file.component';
 import { DeleteComponent } from '../basic-modals/delete-confirm/delete-confirm.component';
+import { ReplaceComponent } from '../basic-modals/replace-confirm';
 
 import { AdminService } from '../services/admin.service';
 import { ClientService } from '../services/client.service';
@@ -13,7 +14,7 @@ import { SampleBusinessNetworkService } from '../services/samplebusinessnetwork.
 import { AlertService } from '../services/alert.service';
 import { EditorService } from '../services/editor.service';
 
-import { ModelFile, ScriptManager, ModelManager } from 'composer-common';
+import { ModelFile, Script, ScriptManager, ModelManager } from 'composer-common';
 
 import 'rxjs/add/operator/takeWhile';
 import { saveAs } from 'file-saver';
@@ -287,6 +288,30 @@ export class EditorComponent implements OnInit, OnDestroy {
         this.dirty = true;
     }
 
+    addReadme(readme) {
+        if (this.files[0].readme) {
+            const confirmModalRef = this.modalService.open(ReplaceComponent);
+
+            confirmModalRef.componentInstance.mainMessage = 'Your current README file will be replaced.';
+            confirmModalRef.componentInstance.supplementaryMessage = 'Please ensure that you have saved a copy of your README file to disc.';
+            confirmModalRef.result.then((result) => {
+                this.clientService.setBusinessNetworkReadme(readme);
+                this.updateFiles();
+                this.setCurrentFile(this.files[0]);
+                this.dirty = true;
+        }, (reason) => {
+            if (reason && reason !== 1) {
+                this.alertService.errorStatus$.next(reason);
+            }
+        });
+        } else {
+            this.clientService.setBusinessNetworkReadme(readme);
+            this.updateFiles();
+            this.setCurrentFile(this.files[0]);
+            this.dirty = true;
+        }
+    }
+
     openImportModal() {
         this.modalService.open(ImportComponent).result.then((result) => {
             this.updatePackageInfo();
@@ -325,8 +350,10 @@ export class EditorComponent implements OnInit, OnDestroy {
             if (result !== 0) {
                 if (result instanceof ModelFile) {
                     this.addModelFile(result);
-                } else {
+                } else if (result instanceof Script) {
                     this.addScriptFile(result);
+                } else {
+                    this.addReadme(result);
                 }
                 this.clientService.businessNetworkChanged$.next(true);
             }
diff --git a/packages/composer-playground/src/app/import/import.component.spec.ts b/packages/composer-playground/src/app/import/import.component.spec.ts
index 5d38969580..6ed9502b33 100644
--- a/packages/composer-playground/src/app/import/import.component.spec.ts
+++ b/packages/composer-playground/src/app/import/import.component.spec.ts
@@ -316,6 +316,7 @@ describe('ImportComponent', () => {
             let deployGithubMock = sinon.stub(component, 'deployFromGitHub').returns(Promise.resolve());
 
             mockNgbModal.open = sinon.stub().returns({
+                componentInstance: {},
                 result: Promise.resolve(true)
             });
 
@@ -332,6 +333,7 @@ describe('ImportComponent', () => {
         it('should deploy a business network from business network', fakeAsync(() => {
 
             mockNgbModal.open = sinon.stub().returns({
+                componentInstance: {},
                 result: Promise.resolve(true)
             });
 
diff --git a/packages/composer-playground/src/app/import/import.component.ts b/packages/composer-playground/src/app/import/import.component.ts
index 169cba40d3..22ce35dd7e 100644
--- a/packages/composer-playground/src/app/import/import.component.ts
+++ b/packages/composer-playground/src/app/import/import.component.ts
@@ -131,7 +131,10 @@ export class ImportComponent implements OnInit {
     }
 
     deploy() {
-        this.modalService.open(ReplaceComponent).result.then((result) => {
+        const confirmModalRef = this.modalService.open(ReplaceComponent);
+        confirmModalRef.componentInstance.mainMessage = 'Your Business Network Definition currently in the Playground will be removed & replaced.';
+        confirmModalRef.componentInstance.supplementaryMessage = 'Please ensure that you have exported any current model files in the Playground.';
+        confirmModalRef.result.then((result) => {
             if (result === true) {
                 this.deployInProgress = true;
                 let deployPromise;
diff --git a/packages/composer-playground/src/app/services/client.service.spec.ts b/packages/composer-playground/src/app/services/client.service.spec.ts
index db62b7d18d..a09fd13efe 100644
--- a/packages/composer-playground/src/app/services/client.service.spec.ts
+++ b/packages/composer-playground/src/app/services/client.service.spec.ts
@@ -68,6 +68,13 @@ describe('ClientService', () => {
 
             result.should.deep.equal(businessNetworkConMock);
         }));
+
+        it('should create a new business network connection if none exist', inject([ClientService], (service: ClientService) => {
+            let mockCreate = sinon.stub(service, 'createBusinessNetworkConnection');
+            let result = service.getBusinessNetworkConnection();
+
+            mockCreate.should.have.been.called;
+        }));
     });
 
     describe('getBusinessNetwork', () => {
@@ -616,6 +623,22 @@ describe('ClientService', () => {
             mockCreateBusinessNetwork = sinon.stub(service, 'createBusinessNetwork').returns(businessNetworkDefMock);
         }));
 
+        it('should set business network readme', inject([ClientService], (service: ClientService) => {
+            let businessNetworkChangedSpy = sinon.spy(service.businessNetworkChanged$, 'next');
+
+            businessNetworkDefMock.getMetadata.returns({
+                getVersion: sinon.stub().returns('my version'),
+                getDescription: sinon.stub().returns('my description'),
+                getPackageJson: sinon.stub().returns({package: 'such data'}),
+                getName: sinon.stub().returns('my name')
+            });
+
+            service.setBusinessNetworkReadme('my readme');
+
+            mockCreateBusinessNetwork.should.have.been.calledWith('my name@my version', 'my description', {package: 'such data'}, 'my readme');
+            businessNetworkChangedSpy.should.have.been.calledWith(true);
+        }));
+
         it('should set business network name', inject([ClientService], (service: ClientService) => {
             let businessNetworkChangedSpy = sinon.spy(service.businessNetworkChanged$, 'next');
 
diff --git a/packages/composer-playground/src/app/services/client.service.ts b/packages/composer-playground/src/app/services/client.service.ts
index 093128dd86..00186eb147 100644
--- a/packages/composer-playground/src/app/services/client.service.ts
+++ b/packages/composer-playground/src/app/services/client.service.ts
@@ -44,9 +44,14 @@ export class ClientService {
         return new BusinessNetworkDefinition(identifier, description, packageJson, readme);
     }
 
+    // horrible hack for tests
+    createBusinessNetworkConnection() {
+        return new BusinessNetworkConnection();
+    }
+
     getBusinessNetworkConnection(): BusinessNetworkConnection {
         if (!this.businessNetworkConnection) {
-            this.businessNetworkConnection = new BusinessNetworkConnection();
+            this.businessNetworkConnection = this.createBusinessNetworkConnection();
         }
         return this.businessNetworkConnection;
     }
@@ -169,6 +174,15 @@ export class ClientService {
         return this.getBusinessNetwork().getMetadata();
     }
 
+    setBusinessNetworkReadme(readme) {
+        let name = this.getBusinessNetwork().getMetadata().getName();
+        let description = this.getBusinessNetwork().getMetadata().getDescription();
+        let packageJson = this.getBusinessNetwork().getMetadata().getPackageJson();
+        let version = this.getBusinessNetwork().getMetadata().getVersion();
+
+        this.createNewBusinessNetwork(name, version, description, packageJson, readme);
+    }
+
     setBusinessNetworkName(name: string) {
         let version = this.getBusinessNetwork().getMetadata().getVersion();
         let description = this.getBusinessNetwork().getMetadata().getDescription();
diff --git a/packages/composer-playground/src/assets/svg/other/MD_File.svg b/packages/composer-playground/src/assets/svg/other/MD_File.svg
new file mode 100644
index 0000000000..65afd67be7
--- /dev/null
+++ b/packages/composer-playground/src/assets/svg/other/MD_File.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="54.72" height="73.59" viewBox="0 0 54.72 73.59"><defs><style>.\35 d65cac3-18ab-4b4a-b6e1-0f8a392cef93{fill:#2e3f8f;}.e1380211-ed5a-41ec-a444-9e9230091948{fill:#d1d7f4;}</style></defs><title>md_file</title><g id="53c27eba-9247-473d-b204-37ba47f8dcc6" data-name="Layer 2"><g id="e0d26f3e-1fc5-4b94-9c60-fffb899be41d" data-name="Layer 1"><path class="5d65cac3-18ab-4b4a-b6e1-0f8a392cef93" d="M53.72,0,18.48,0h-.07a1,1,0,0,0-.26.05l-.1,0a1,1,0,0,0-.29.19L.35,17.68a1,1,0,0,0-.28.84s0,0,0,.07L0,72.53a1,1,0,0,0,1,1l52.64.06h0a1,1,0,0,0,1-1L54.72,1A1,1,0,0,0,53.72,0ZM17.48,3.41v14h-14ZM52.64,71.59,2,71.53l.06-51.94,16.4,0h0a1,1,0,0,0,1-1v-.2h0l0-14.64V2L52.72,2Z"/><path class="e1380211-ed5a-41ec-a444-9e9230091948" d="M39.16,68.84a1,1,0,0,1,0-2l8.74-.1,0-8.47a1,1,0,0,1,1-1h0a1,1,0,0,1,1,1l0,9.45a1,1,0,0,1-1,1l-9.72.11Z"/><path class="5d65cac3-18ab-4b4a-b6e1-0f8a392cef93" d="M16.87,43.26a1,1,0,0,1,.26-.74,1.07,1.07,0,0,1,.77-.25,1,1,0,0,1,.75.26,1.14,1.14,0,0,1,0,1.47,1,1,0,0,1-.75.27,1.05,1.05,0,0,1-.76-.26A1,1,0,0,1,16.87,43.26Z"/><path class="5d65cac3-18ab-4b4a-b6e1-0f8a392cef93" d="M26.41,44.09H24.63V40.27a1.93,1.93,0,0,0-.24-1.06.83.83,0,0,0-.75-.35,1.08,1.08,0,0,0-1,.5A3.31,3.31,0,0,0,22.33,41v3.08H20.55V37.54h1.37l.24.84h.1a1.82,1.82,0,0,1,.76-.71,2.47,2.47,0,0,1,1.14-.25,2.06,2.06,0,0,1,2,1h.16a1.77,1.77,0,0,1,.78-.71,2.59,2.59,0,0,1,1.16-.25,2.28,2.28,0,0,1,1.68.57,2.51,2.51,0,0,1,.57,1.83v4.27H28.7V40.27a1.93,1.93,0,0,0-.24-1.06.83.83,0,0,0-.75-.35,1.11,1.11,0,0,0-1,.47,2.66,2.66,0,0,0-.33,1.49Z"/><path class="5d65cac3-18ab-4b4a-b6e1-0f8a392cef93" d="M34.4,44.21a2.13,2.13,0,0,1-1.81-.9,4.12,4.12,0,0,1-.66-2.48,4.13,4.13,0,0,1,.67-2.51,2.18,2.18,0,0,1,1.85-.9,2.14,2.14,0,0,1,1.89,1h.06a7.31,7.31,0,0,1-.13-1.31V35h1.79v9.12H36.68l-.35-.85h-.08A2,2,0,0,1,34.4,44.21ZM35,42.79a1.21,1.21,0,0,0,1-.4A2.32,2.32,0,0,0,36.38,41v-.19a2.68,2.68,0,0,0-.33-1.51A1.21,1.21,0,0,0,35,38.87a1,1,0,0,0-.93.51,2.7,2.7,0,0,0-.33,1.47,2.56,2.56,0,0,0,.33,1.45A1.09,1.09,0,0,0,35,42.79Z"/></g></g></svg>
\ No newline at end of file

From 636359a57273950ee149e33c91a3faadf037adaa Mon Sep 17 00:00:00 2001
From: nklincoln <nkl199@yahoo.co.uk>
Date: Wed, 7 Jun 2017 15:01:38 +0100
Subject: [PATCH 2/2] add playground manual test reqs

---
 .../release-process/playground-validation.md          | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/contrib-notes/release-process/playground-validation.md b/contrib-notes/release-process/playground-validation.md
index fdeec60f4a..7bfdfeccbd 100644
--- a/contrib-notes/release-process/playground-validation.md
+++ b/contrib-notes/release-process/playground-validation.md
@@ -95,6 +95,9 @@ From the initial logon, the user should be presented with the “Hello World”
 
 ## Playground Test Areas
 
+### General
+Check that all page links are linking correctly (no 404s)
+
 ### Define Page (Side Navigation)
 The define page is used to manage files and file content. Through the side navigation menu it is possible to perform working file selection/creation, and lifecycle actions such as import, export and deploy.
 
@@ -130,6 +133,14 @@ Following from reset to basic sample network by import of the basic sample netwo
     - deploy button no longer active
     - All files previously visible remain in navigation
  - Repeat to add another script and model file
+ - Add a ReadMe file via the "AddFile" option and browsing to a ReadMe file on disc
+    - On selection the modal should indicate that a Readme file is to be imported
+    - On confirmation a warning modal should inform that the current readme will be overwritten
+    - On confirm, the existing readme should be replaced with that selected
+ - Add a ReadMe file via the "AddFile" option and drag/drop action of a ReadMe file on disc
+    - On selection the modal should indicate that a Readme file is to be imported
+    - On confirmation a warning modal should inform that the current readme will be overwritten
+    - On confirm, the existing readme should be replaced with that selected
  - On export, exported BNA should contain the newly added files (2 script, 2 model)
 
 ### Define Page (File-Editor)