Ensure .card extension in for exported card files (hyperledger-archiv…

…es#3390) For `composer card create` and `composer card export` commands, append the `.card` extension if one is not present in the specified card file name. Signed-off-by: Mark S. Lewis <[email protected]>
eric3361229 · Feb 13, 2018 · 55ed9a0 · 55ed9a0
1 parent 4be0d62
commit 55ed9a0
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 19 deletions.
diff --git a/packages/composer-cli/lib/cmds/card/lib/create.js b/packages/composer-cli/lib/cmds/card/lib/create.js
@@ -93,7 +93,6 @@ class Create {
      * @returns {Promise} resolved with the filename of the card when it has been written
      */
     static createCard(metadata,profileData,argv){
-        let fileName;
         // setup the id card with the meta data
         let idCard = new IdCard(metadata,profileData);
 
@@ -110,18 +109,7 @@ class Create {
             idCard.setCredentials(newCredentials);
         }
 
-        // handle the filename
-        // Default is userName@businessNetworkName.card if the card includes a business network name;
-        // otherwise userName@connectionProfileName.card.
-        if (!argv.file) {
-            if (metadata.hasOwnProperty('businessNetwork')){
-                fileName = metadata.userName+'@'+ metadata.businessNetwork+'.card';
-            } else {
-                fileName = metadata.userName+'@'+ profileData.name +'.card';
-            }
-        } else {
-            fileName = argv.file;
-        }
+        const fileName = cmdUtil.sanitizeCardFileName(argv.file || cmdUtil.getDefaultCardName(idCard));
 
         // finally write out the card file
         return Export.writeCardToFile(fileName,idCard)

diff --git a/packages/composer-cli/lib/cmds/card/lib/export.js b/packages/composer-cli/lib/cmds/card/lib/export.js
@@ -31,7 +31,7 @@ class Export {
     static handler(args) {
 
         const cardName = args.name;
-        const fileName = args.file || (cardName + '.card');
+        const fileName = cmdUtil.sanitizeCardFileName(args.file || cardName);
 
         const adminConnection = cmdUtil.createAdminConnection();
         return adminConnection.exportCard(cardName)

diff --git a/packages/composer-cli/lib/cmds/utils/cmdutils.js b/packages/composer-cli/lib/cmds/utils/cmdutils.js
@@ -252,6 +252,19 @@ class CmdUtil {
         }
         return archiveFileContents;
     }
+
+    /**
+     * Generate a suitable card file name based on a proposed file name.
+     * This implementation simply appends '.card' if it is missing.
+     * @param {String} fileName Proposed card file name
+     * @return {String} A card file name
+     */
+    static sanitizeCardFileName(fileName) {
+        if (!/\.card$/i.test(fileName)) {
+            fileName = fileName + '.card';
+        }
+        return fileName;
+    }
 }
 
 module.exports = CmdUtil;
diff --git a/packages/composer-cli/test/card/export.js b/packages/composer-cli/test/card/export.js
@@ -38,6 +38,8 @@ describe('composer card export CLI', function() {
         sandbox.stub(CmdUtil, 'createAdminConnection').returns(adminConnectionStub);
         consoleLogSpy = sandbox.spy(console, 'log');
         sandbox.stub(process, 'exit');
+        // Throw by default for writing files so we can allow only certain file names in specific tests
+        sandbox.stub(fs, 'writeFileSync').throws();
 
         testCard = new IdCard({ userName: 'conga' }, { name: 'profileName' });
     });
@@ -47,7 +49,7 @@ describe('composer card export CLI', function() {
     });
 
     it('should export to specified file name', function() {
-        sandbox.stub(fs, 'writeFileSync').withArgs(cardFileName);
+        fs.writeFileSync.withArgs(cardFileName).returns();
         const args = {
             file: cardFileName,
             name : 'CARD_NAME'
@@ -60,22 +62,36 @@ describe('composer card export CLI', function() {
         });
     });
 
+    it('should always export to .card file', function() {
+        const fileName = '/TestCard';
+        fs.writeFileSync.withArgs(fileName + '.card').returns();
+        const args = {
+            file: fileName,
+            name : 'CARD_NAME'
+        };
+
+        adminConnectionStub.exportCard.resolves(testCard);
+        return ExportCmd.handler(args).then(() => {
+            sinon.assert.calledOnce(adminConnectionStub.exportCard);
+            sinon.assert.calledWith(consoleLogSpy, sinon.match(args.name));
+        });
+    });
+
     it('should export to default file name if none specified', function() {
         const args = {
             name : 'CARD_NAME'
         };
-        const expectedFileName = args.name + '.card';
-        sandbox.stub(fs, 'writeFileSync').withArgs(expectedFileName);
+        const expectedFileName = sinon.match(new RegExp(args.name + '\.card$'));
+        fs.writeFileSync.withArgs(expectedFileName).returns();
 
         adminConnectionStub.exportCard.resolves(testCard);
         return ExportCmd.handler(args).then(() => {
             sinon.assert.calledOnce(adminConnectionStub.exportCard);
-            sinon.assert.calledWith(consoleLogSpy, sinon.match(expectedFileName));
+            sinon.assert.calledWith(consoleLogSpy, expectedFileName);
         });
     });
 
     it('should copy with the file system write failing', function() {
-        sandbox.stub(fs, 'writeFileSync').withArgs(cardFileName).throws(new Error('Failed to write'));
         const args = {
             file: cardFileName,
             name : 'CARD_NAME'

diff --git a/packages/composer-cli/test/utils/cmdutils.js b/packages/composer-cli/test/utils/cmdutils.js
@@ -398,4 +398,20 @@ describe('composer transaction cmdutils unit tests', () => {
         });
     });
 
+    describe('#sanitizeCardFileName', () => {
+        it('should append .card if missing', () => {
+            CmdUtil.sanitizeCardFileName('card').should.equal('card.card');
+        });
+
+        it ('should not change file name with .card extension', () => {
+            const fileName = 'fileName.card';
+            CmdUtil.sanitizeCardFileName(fileName).should.equal(fileName);
+        });
+
+        it ('should use case-insensitive detection of .card extension', () => {
+            const fileName = 'fileName.CARD';
+            CmdUtil.sanitizeCardFileName(fileName).should.equal(fileName);
+        });
+    });
+
 });