Merge lp:~sergiusens/snapcraft/meta-all-yaml into lp:~snappy-dev/snapcraft/core

[Sergio Schvezov]

Generate meta (package.yaml and readme.md) from snapcraft.yaml

This will break many of the current snapcraft implementations so before merging this it would be good to have daily builds disabled.

Additionally this raises the usefulness of assemble (maybe we can be smarter) and detect a manual 'meta' and warn about it.

Code coverage seems high, but I didn't cover one line of code from migrated code which I can do in another MP.

[lp:~sergiusens/snapcraft/meta-all-yaml]

138. By Sergio Schvezov on 2015-08-25

rogue deprecated assertEquals

139. By Sergio Schvezov on 2015-08-25

updating examples

140. By Sergio Schvezov on 2015-08-25

take into account the optional type and frameworks

[Sergio Schvezov (sergiusens)]

Forgot to add the examples (I had only touched the integration tests and had forgotten). I also added two rather important keys missing from the spec, type and frameworks

[Leo Arias (elopio)]

Cool stuff with tests :)
Some of the branches from the wrap methods are not tested. This is already big, so feel free to make a card or a bug for that.

Plenty of comments in the diff.

review: Needs Fixing

[Sergio Schvezov (sergiusens)]

> Cool stuff with tests :)

Thanks for the review
> Some of the branches from the wrap methods are not tested. This is already
> big, so feel free to make a card or a bug for that.

_wrap_tests is not new code, just moved, so I won't be adding tests in this MP for it and leave a TODO.

> Plenty of comments in the diff.

Thanks, I will take a look now

[lp:~sergiusens/snapcraft/meta-all-yaml]

141. By Sergio Schvezov on 2015-08-26

First round of review fixes

[Sergio Schvezov (sergiusens)]

I addressed most of the review comments, please take another look.

[Leo Arias (elopio)]

Ok, I'm happy with this. I just proposed a branch with the patcher change and the tests passing:
https://code.launchpad.net/~elopio/snapcraft/patcher/+merge/269239

What's important is to use addCleanup instead of tearDown. From the docs: "if an exception is raised in the setUp then tearDown is not called."

Leaving my +1. Thanks Sergio!

review: Approve

[lp:~sergiusens/snapcraft/meta-all-yaml]

142. By Sergio Schvezov on 2015-08-26

testing fixes from elopio

143. By Sergio Schvezov on 2015-08-27

Merging trunk

[John Lenton (chipaca)]

Can we have single-file config in snappy too?

review: Approve

=== removed directory 'examples/godd/meta'
=== removed file 'examples/godd/meta/package.yaml'
--- examples/godd/meta/package.yaml	2015-06-24 16:32:33 +0000
+++ examples/godd/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-name: godd
-version: 1.0
-vendor: Michael Vogt <[e-mail]>
-binaries:
-  - name: ./bin/godd

=== removed file 'examples/godd/meta/readme.md'
--- examples/godd/meta/readme.md	2015-06-24 16:32:33 +0000
+++ examples/godd/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-Simple dd like tool

=== modified file 'examples/godd/snapcraft.yaml'
--- examples/godd/snapcraft.yaml	2015-07-31 15:12:07 +0000
+++ examples/godd/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,5 +1,12 @@
+name: godd
+version: 1.0
+vendor: Michael Vogt <[e-mail]>
+binaries:
+  - name: ./bin/godd
+summary: Simple dd like tool
+description: written in go so it is self contained and really portable, you would need to use hw-assign to access devices.
+
 parts:
   godd:
     plugin: go-project
     source: git://github.com/mvo5/godd
-snappy-metadata: meta

=== removed directory 'examples/gopaste/meta'
=== removed file 'examples/gopaste/meta/package.yaml'
--- examples/gopaste/meta/package.yaml	2015-06-25 13:22:56 +0000
+++ examples/gopaste/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,7 +0,0 @@
-name: gopaste
-version: 1.0
-vendor: [e-mail]
-services:
-  - name: gopaste
-    description: "gopaste"
-    start: bin/gopaste

=== removed file 'examples/gopaste/meta/readme.md'
--- examples/gopaste/meta/readme.md	2015-06-25 13:22:56 +0000
+++ examples/gopaste/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-Simple dd like tool

=== modified file 'examples/gopaste/snapcraft.yaml'
--- examples/gopaste/snapcraft.yaml	2015-07-31 15:12:07 +0000
+++ examples/gopaste/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,5 +1,14 @@
+name: gopaste
+version: 1.0
+vendor: Michael Terry <[e-mail]>
+services:
+  - name: gopaste
+    description: "gopaste"
+    start: bin/gopaste
+summary: Simple pasting tool
+description: Runs a service that allows you to paste to and share.
+
 parts:
   gopaste:
     plugin: go-project
     source: git://github.com/wisnij/gopaste/gopasted
-snappy-metadata: meta

=== removed directory 'examples/java-hello-world/meta'
=== removed file 'examples/java-hello-world/meta/package.yaml'
--- examples/java-hello-world/meta/package.yaml	2015-07-20 21:11:39 +0000
+++ examples/java-hello-world/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,6 +0,0 @@
-name: java-hello-world
-version: 0
-vendor: [e-mail]
-binaries:
- - name: hello
-   exec: bin/wrapper

=== removed file 'examples/java-hello-world/meta/readme.md'
--- examples/java-hello-world/meta/readme.md	2015-07-20 21:11:39 +0000
+++ examples/java-hello-world/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-An example

=== modified file 'examples/java-hello-world/snapcraft.yaml'
--- examples/java-hello-world/snapcraft.yaml	2015-07-22 17:57:42 +0000
+++ examples/java-hello-world/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,12 @@
+name: java-hello-world
+version: 0
+vendor: Michael Terry <[e-mail]>
+binaries:
+ - name: hello
+   exec: bin/wrapper
+summary: A java exmaple
+description: this is not much more than an example
+
 parts:
     local:
         plugin: ant-project
@@ -5,4 +14,3 @@
     wrapper:
         plugin: make-project
         source: .
-snappy-metadata: meta

=== removed directory 'examples/libpipeline/meta'
=== removed file 'examples/libpipeline/meta/package.yaml'
--- examples/libpipeline/meta/package.yaml	2015-06-24 17:00:33 +0000
+++ examples/libpipeline/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-name: pipelinetest
-version: 1.0
-vendor: Mike Terry
-binaries:
-  - name: ./bin/pipelinetest

=== removed file 'examples/libpipeline/meta/readme.md'
--- examples/libpipeline/meta/readme.md	2015-06-24 17:00:33 +0000
+++ examples/libpipeline/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-Libpipeline example

=== modified file 'examples/libpipeline/snapcraft.yaml'
--- examples/libpipeline/snapcraft.yaml	2015-07-15 16:26:06 +0000
+++ examples/libpipeline/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,11 @@
+name: pipelinetest
+version: 1.0
+vendor: Mike Terry <[e-mail]>
+binaries:
+  - name: ./bin/pipelinetest
+summary: Libpipeline example
+description: this is an example package of an autotools project built with snapcraft using
+
 parts:
     pipelinetest:
         plugin: make-project
@@ -7,4 +15,3 @@
     libpipeline:
         plugin: autotools-project
         source: lp:~mterry/libpipeline/printf
-snappy-metadata: meta

=== removed directory 'examples/py2-project/meta'
=== removed file 'examples/py2-project/meta/package.yaml'
--- examples/py2-project/meta/package.yaml	2015-07-17 14:44:45 +0000
+++ examples/py2-project/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-name: spongeshaker
-version: 0
-vendor: [e-mail]
-binaries:
- - name: ./bin/sha3sum

=== removed file 'examples/py2-project/meta/readme.md'
--- examples/py2-project/meta/readme.md	2015-07-17 14:44:45 +0000
+++ examples/py2-project/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-A python sha3 implementation

=== modified file 'examples/py2-project/snapcraft.yaml'
--- examples/py2-project/snapcraft.yaml	2015-08-04 21:54:52 +0000
+++ examples/py2-project/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,7 +1,14 @@
+name: spongeshaker
+version: 0
+vendor: Michael Vogt <[e-mail]>
+binaries:
+ - name: ./bin/sha3sum
+summary: A python sha3 implementation
+description: A python2 project using snapcraft
+
 parts:
   spongeshaker:
     plugin: python2-project
     source: git://github.com/markokr/spongeshaker.git
   make-project:
     source: .
-snappy-metadata: meta

=== removed directory 'examples/py3-project/meta'
=== removed file 'examples/py3-project/meta/package.yaml'
--- examples/py3-project/meta/package.yaml	2015-07-15 10:32:45 +0000
+++ examples/py3-project/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-name: spongeshaker
-version: 0
-vendor: [e-mail]
-binaries:
- - name: bin/sha3sum

=== removed file 'examples/py3-project/meta/readme.md'
--- examples/py3-project/meta/readme.md	2015-07-13 08:28:40 +0000
+++ examples/py3-project/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-A python sha3 implementation

=== modified file 'examples/py3-project/snapcraft.yaml'
--- examples/py3-project/snapcraft.yaml	2015-07-22 21:16:59 +0000
+++ examples/py3-project/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,11 @@
+name: spongeshaker
+version: 0
+vendor: Michael Vogt <[e-mail]>
+binaries:
+ - name: bin/sha3sum
+summary: A python sha3 implementation
+description: A python2 project using snapcraft
+
 parts:
   spongeshaker:
     plugin: python3-project
@@ -6,4 +14,3 @@
     plugin: copy
     files:
      sha3sum.py: bin/sha3sum
-snappy-metadata: meta

=== modified file 'examples/qmldemo/snapcraft.yaml'
--- examples/qmldemo/snapcraft.yaml	2015-07-22 14:35:51 +0000
+++ examples/qmldemo/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,8 +1,20 @@
+name: qmldemo
+version: 1
+vendor: Ted Gould <[e-mail]>
+frameworks:
+  - mir
+binaries:
+  - name: qmldemo
+    exec: qmlscene demo.qml --
+    caps:
+      - mir_client
+      - network-client
+summary: qml demo
+description: An example of shipping a usable QML file in a snap using the QML plugin.
+
 parts:
   qml:
     plugin: qml
   qmldemo:
     plugin: copy
     files:
-      demo.qml: demo.qml
-snappy-metadata: meta

=== removed directory 'examples/tomcat-maven-webapp/meta'
=== removed file 'examples/tomcat-maven-webapp/meta/package.yaml'
--- examples/tomcat-maven-webapp/meta/package.yaml	2015-08-19 17:42:25 +0000
+++ examples/tomcat-maven-webapp/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,12 +0,0 @@
-name: tomcat-webapp-demo
-vendor: Loïc Minier <[e-mail]>
-version: 1.0
-architectures:
- - amd64
-services:
- - name: tomcat
-   start: bin/wrapper
-   caps:
-   - networking
-   - network-service
-

=== removed file 'examples/tomcat-maven-webapp/meta/readme.md'
--- examples/tomcat-maven-webapp/meta/readme.md	2015-07-24 01:59:59 +0000
+++ examples/tomcat-maven-webapp/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,3 +0,0 @@
-Demo of Tomcat-hosted Webapp
-
-This is a demo snap of a Tomcat-hosted webapp produced by snapcraft with maven.

=== modified file 'examples/tomcat-maven-webapp/snapcraft.yaml'
--- examples/tomcat-maven-webapp/snapcraft.yaml	2015-07-24 03:32:54 +0000
+++ examples/tomcat-maven-webapp/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,17 @@
+name: tomcat-webapp-demo
+vendor: Loïc Minier <[e-mail]>
+version: 1.0
+architectures:
+ - amd64
+services:
+ - name: tomcat
+   start: bin/wrapper
+   caps:
+   - networking
+   - network-service
+summary: Demo of Tomcat-hosted Webapp
+description: This is a demo snap of a Tomcat-hosted webapp produced by snapcraft with maven.
+
 parts:
     webapp:
         plugin: maven-project
@@ -8,4 +22,3 @@
     local-files:
         plugin: make-project
         source: .
-snappy-metadata: meta

=== removed directory 'examples/webcam-webui-snap/meta'
=== removed file 'examples/webcam-webui-snap/meta/package.yaml'
--- examples/webcam-webui-snap/meta/package.yaml	2015-06-25 13:22:56 +0000
+++ examples/webcam-webui-snap/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,7 +0,0 @@
-name: webcam-webui
-version: 1.0.0
-vendor: Loïc Minier <[e-mail]>
-services:
- - name: webcam-webui
-   start: bin/webcam-webui
-   security-template: unconfined

=== removed file 'examples/webcam-webui-snap/meta/readme.md'
--- examples/webcam-webui-snap/meta/readme.md	2015-06-25 13:22:56 +0000
+++ examples/webcam-webui-snap/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,3 +0,0 @@
-Webcam web UI
-
-Exposes your webcam over a web UI

=== modified file 'examples/webcam-webui-snap/snapcraft.yaml'
--- examples/webcam-webui-snap/snapcraft.yaml	2015-08-06 14:59:07 +0000
+++ examples/webcam-webui-snap/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,13 @@
+name: webcam-webui
+version: 1.0.0
+vendor: Loïc Minier <[e-mail]>
+services:
+ - name: webcam-webui
+   start: bin/webcam-webui
+   security-template: unconfined
+summary: Webcam web UI
+description: Exposes your webcam over a web UI
+
 parts:
     golang-static-http:
         plugin: go-project
@@ -8,4 +18,3 @@
         plugin: copy
         files:
             webcam-webui: bin/webcam-webui
-snappy-metadata: meta

=== removed directory 'examples/wget-deb/meta'
=== removed file 'examples/wget-deb/meta/package.yaml'
--- examples/wget-deb/meta/package.yaml	2015-06-24 18:51:27 +0000
+++ examples/wget-deb/meta/package.yaml	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-name: wget
-version: 0
-vendor: [e-mail]
-binaries:
-    - name: usr/bin/wget

=== removed file 'examples/wget-deb/meta/readme.md'
--- examples/wget-deb/meta/readme.md	2015-06-24 18:51:27 +0000
+++ examples/wget-deb/meta/readme.md	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-wget

=== modified file 'examples/wget-deb/snapcraft.yaml'
--- examples/wget-deb/snapcraft.yaml	2015-08-05 18:40:06 +0000
+++ examples/wget-deb/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,4 +1,11 @@
+name: wget
+version: 0
+vendor: Michael Terry <[e-mail]>
+binaries:
+    - name: usr/bin/wget
+summary: wget for snappy
+description: a basic example from ubuntu packages
+
 parts:
   wget:
     plugin: ubuntu
-snappy-metadata: meta

=== removed file 'integration-tests/data/assemble/package.yaml.after'
--- integration-tests/data/assemble/package.yaml.after	2015-08-03 14:46:32 +0000
+++ integration-tests/data/assemble/package.yaml.after	1970-01-01 00:00:00 +0000
@@ -1,13 +0,0 @@
-architecture: @ARCH@
-binaries:
-- exec: binary1.wrapper
-  name: assemble-bin
-- exec: subdir/binary2.wrapper
-  name: binary2
-name: assemble
-services:
-- name: assemble-service
-  start: service-start.wrapper
-  stop: service-stop.wrapper with args
-vendor: [e-mail]
-version: 1.0

=== modified file 'integration-tests/data/assemble/snapcraft.yaml'
--- integration-tests/data/assemble/snapcraft.yaml	2015-07-15 16:26:06 +0000
+++ integration-tests/data/assemble/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,18 @@
+name: assemble
+version: 1.0
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+binaries:
+  - exec: binary1
+    name: assemble-bin
+  - exec: subdir/binary2
+    name: binary2
+services:
+  - name: assemble-service
+    start: service-start
+    stop: service-stop with args
+
 parts:
     make-project:
         source: .

=== modified file 'integration-tests/data/bzr-head/snapcraft.yaml'
--- integration-tests/data/bzr-head/snapcraft.yaml	2015-07-14 21:15:07 +0000
+++ integration-tests/data/bzr-head/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     bzr:
         plugin: make-project

=== modified file 'integration-tests/data/bzr-tag/snapcraft.yaml'
--- integration-tests/data/bzr-tag/snapcraft.yaml	2015-07-14 21:15:07 +0000
+++ integration-tests/data/bzr-tag/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     bzr:
         plugin: make-project

=== modified file 'integration-tests/data/conflicts/snapcraft.yaml'
--- integration-tests/data/conflicts/snapcraft.yaml	2015-07-08 20:45:52 +0000
+++ integration-tests/data/conflicts/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
   p1:
     plugin: make-project

=== modified file 'integration-tests/data/dependencies/snapcraft.yaml'
--- integration-tests/data/dependencies/snapcraft.yaml	2015-07-08 20:45:52 +0000
+++ integration-tests/data/dependencies/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
   p1:
     plugin: make-project

=== modified file 'integration-tests/data/git-branch/snapcraft.yaml'
--- integration-tests/data/git-branch/snapcraft.yaml	2015-07-14 21:15:07 +0000
+++ integration-tests/data/git-branch/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     git:
         plugin: make-project

=== modified file 'integration-tests/data/git-head/snapcraft.yaml'
--- integration-tests/data/git-head/snapcraft.yaml	2015-07-14 21:15:07 +0000
+++ integration-tests/data/git-head/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     git:
         plugin: make-project

=== modified file 'integration-tests/data/git-tag/snapcraft.yaml'
--- integration-tests/data/git-tag/snapcraft.yaml	2015-07-14 21:15:07 +0000
+++ integration-tests/data/git-tag/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     git:
         plugin: make-project

=== modified file 'integration-tests/data/hg-branch/snapcraft.yaml'
--- integration-tests/data/hg-branch/snapcraft.yaml	2015-08-05 23:04:22 +0000
+++ integration-tests/data/hg-branch/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     mercurial:
         plugin: make-project

=== modified file 'integration-tests/data/hg-head/snapcraft.yaml'
--- integration-tests/data/hg-head/snapcraft.yaml	2015-08-05 23:04:22 +0000
+++ integration-tests/data/hg-head/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     mercurial:
         plugin: make-project

=== modified file 'integration-tests/data/hg-tag/snapcraft.yaml'
--- integration-tests/data/hg-tag/snapcraft.yaml	2015-08-05 23:04:22 +0000
+++ integration-tests/data/hg-tag/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     mercurial:
         plugin: make-project

=== modified file 'integration-tests/data/local-plugin/snapcraft.yaml'
--- integration-tests/data/local-plugin/snapcraft.yaml	2015-07-21 18:18:10 +0000
+++ integration-tests/data/local-plugin/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,2 +1,8 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     x-local-plugin:

=== modified file 'integration-tests/data/local-source/snapcraft.yaml'
--- integration-tests/data/local-source/snapcraft.yaml	2015-07-02 20:30:03 +0000
+++ integration-tests/data/local-source/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
     make-project:
         source: .

=== modified file 'integration-tests/data/simple-cmake/snapcraft.yaml'
--- integration-tests/data/simple-cmake/snapcraft.yaml	2015-07-09 13:32:43 +0000
+++ integration-tests/data/simple-cmake/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
   cmake-project:
     source: .

=== modified file 'integration-tests/data/simple-copy/snapcraft.yaml'
--- integration-tests/data/simple-copy/snapcraft.yaml	2015-07-14 12:29:17 +0000
+++ integration-tests/data/simple-copy/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
   copy-example:
     plugin: copy

=== modified file 'integration-tests/data/simple-make/snapcraft.yaml'
--- integration-tests/data/simple-make/snapcraft.yaml	2015-07-06 13:18:53 +0000
+++ integration-tests/data/simple-make/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
   make-project:
     source: .

=== modified file 'integration-tests/data/simple-tar/snapcraft.yaml'
--- integration-tests/data/simple-tar/snapcraft.yaml	2015-07-24 01:23:44 +0000
+++ integration-tests/data/simple-tar/snapcraft.yaml	2015-08-27 16:38:02 +0000
@@ -1,3 +1,9 @@
+name: test-package
+version: 0.1
+vendor: Sergio Schvezov <[e-mail]>
+summary: one line summary
+description: a longer description
+
 parts:
   oneflat:
     plugin: tar-content

=== modified file 'integration-tests/units/jobs.pxu'
--- integration-tests/units/jobs.pxu	2015-08-06 00:31:23 +0000
+++ integration-tests/units/jobs.pxu	2015-08-27 16:38:02 +0000
@@ -7,16 +7,6 @@
     test $? = 1 || exit 1
     echo $OUTPUT | grep "Could not find snapcraft\.yaml\."
 
-id: snapcraft/normal/assemble-no-meta
-plugin: shell
-estimated_duration: 0.3
-command:
-    set -x
-    cp -rT $PLAINBOX_PROVIDER_DATA/assemble .
-    OUTPUT=$(${SNAPCRAFT} assemble 2>&1)
-    test $? = 1 || exit 1
-    echo $OUTPUT | grep "Missing snappy metadata file"
-
 id: snapcraft/normal/assemble-meta-externally
 plugin: shell
 estimated_duration: 0.3
@@ -34,11 +24,8 @@
 command:
     set -ex
     cp -rT $PLAINBOX_PROVIDER_DATA/assemble .
-    echo "snappy-metadata: snappy" >> snapcraft.yaml
     ${SNAPCRAFT} assemble
     test -e "assemble_1.0_$(dpkg-architecture -qDEB_BUILD_ARCH).snap"
-    sed -i "s/@ARCH@/$(dpkg-architecture -qDEB_BUILD_ARCH)/g" package.yaml.after
-    diff -u package.yaml.after snap/meta/package.yaml
     sed -i "s/@MULTIARCH@/$(dpkg-architecture -qDEB_BUILD_MULTIARCH)/g" binary1.after
     diff -u binary1.after snap/binary1.wrapper
     export SNAP_APP_PATH=`pwd`/snap

=== modified file 'snapcraft/cmds.py'
--- snapcraft/cmds.py	2015-08-26 12:33:12 +0000
+++ snapcraft/cmds.py	2015-08-27 16:38:02 +0000
@@ -23,12 +23,10 @@
 import tempfile
 import time
 
-import yaml
-
 import snapcraft.plugin
 import snapcraft.yaml
 from snapcraft import common
-
+from snapcraft import meta
 
 logger = logging.getLogger(__name__)
 
@@ -62,98 +60,25 @@
     common.run(userCommand)
 
 
-def wrap_exe(relexepath):
-    snapdir = common.get_snapdir()
-    exepath = os.path.join(snapdir, relexepath)
-    wrappath = exepath + '.wrapper'
-
-    try:
-        os.remove(wrappath)
-    except Exception:
-        pass
-
-    wrapexec = '$SNAP_APP_PATH/{}'.format(relexepath)
-    if not os.path.exists(exepath) and '/' not in relexepath:
-        # If it doesn't exist it might be in the path
-        logger.info('Checking to see if "{}" is in the $PATH'.format(relexepath))
-        with tempfile.NamedTemporaryFile('w+') as tempf:
-            script = ('#!/bin/sh\n' +
-                      '{}\n'.format(snapcraft.common.assemble_env()) +
-                      'which "{}"\n'.format(relexepath))
-            tempf.write(script)
-            tempf.flush()
-            if snapcraft.common.run(['/bin/sh', tempf.name], cwd=snapdir):
-                wrapexec = relexepath
-            else:
-                logger.warning('Warning: unable to find "{}" in the path'.format(relexepath))
-
-    assembled_env = common.assemble_env().replace(snapdir, '$SNAP_APP_PATH')
-    script = ('#!/bin/sh\n' +
-              '{}\n'.format(assembled_env) +
-              'exec "{}" $*\n'.format(wrapexec))
-
-    with open(wrappath, 'w+') as f:
-        f.write(script)
-
-    os.chmod(wrappath, 0o755)
-
-    return os.path.relpath(wrappath, snapdir)
-
-
 def snap(args):
     cmd(args)
 
-    # Ensure the snappy metadata files are correct
-    config = snapcraft.yaml.Config()
-
-    if 'snappy-metadata' in config.data:
-        common.run(
-            ['cp', '-arvT', config.data['snappy-metadata'], common.get_snapdir() + '/meta'])
-    if not os.path.exists('snap/meta/package.yaml'):
-        logger.error("Missing snappy metadata file 'meta/package.yaml'.  Try specifying 'snappy-metadata' in snapcraft.yaml, pointing to a meta directory in your source tree.")
-        sys.exit(1)
-
-    # wrap all included commands
-    with open("snap/meta/package.yaml", 'r') as f:
-        package = yaml.load(f)
-
-    common.env = config.snap_env()
-
-    def replace_cmd(execparts, cmd):
-        newparts = [cmd] + execparts[1:]
-        return ' '.join([shlex.quote(x) for x in newparts])
-
-    for binary in package.get('binaries', []):
-        execparts = shlex.split(binary.get('exec', binary['name']))
-        execwrap = wrap_exe(execparts[0])
-        if 'exec' in binary:
-            binary['exec'] = replace_cmd(execparts, execwrap)
-        else:
-            binary['name'] = os.path.basename(binary['name'])
-            binary['exec'] = replace_cmd(execparts, execwrap)
-
-    for binary in package.get('services', []):
-        startpath = binary.get('start')
-        if startpath:
-            startparts = shlex.split(startpath)
-            startwrap = wrap_exe(startparts[0])
-            binary['start'] = replace_cmd(startparts, startwrap)
-        stoppath = binary.get('stop')
-        if stoppath:
-            stopparts = shlex.split(stoppath)
-            stopwrap = wrap_exe(stopparts[0])
-            binary['stop'] = replace_cmd(stopparts, stopwrap)
-
-    # Set architecture if none provided
-    if 'architecture' not in package and 'architectures' not in package:
-        package['architecture'] = snapcraft.common.get_arch()
-
-    with open("snap/meta/package.yaml", 'w') as f:
-        yaml.dump(package, f, default_flow_style=False)
+    # This check is to support manual assembly.
+    if not os.path.exists(os.path.join(common.get_snapdir(), "meta")):
+        arches = [snapcraft.common.get_arch(), ]
+
+        config = snapcraft.yaml.Config()
+
+        # FIXME this should be done in a more contained manner
+        common.env = config.snap_env()
+
+        meta.create(config.data, arches)
 
 
 def assemble(args):
     args.cmd = 'snap'
+    # With all the data in snapcraft.yaml, maybe it's not a good idea to call
+    # snap(args) and just do a snappy build if assemble was explicitly called.
     snap(args)
     common.run(['snappy', 'build', common.get_snapdir()])
 

=== added file 'snapcraft/meta.py'
--- snapcraft/meta.py	1970-01-01 00:00:00 +0000
+++ snapcraft/meta.py	2015-08-27 16:38:02 +0000
@@ -0,0 +1,180 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2015 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import logging
+import shlex
+import tempfile
+import yaml
+
+from snapcraft import common
+
+logger = logging.getLogger(__name__)
+
+
+_MANDATORY_PACKAGE_KEYS = [
+    'name',
+    'version',
+    'vendor',
+]
+
+_OPTIONAL_PACKAGE_KEYS = [
+    'frameworks',
+    'type',
+]
+
+
+def create(config_data, arches=None):
+    '''
+    Create  the meta directory and provision it with package.yaml and readme.md
+    in the snap dir using information from config_data and arches.
+    If provided arches, is a list of arches.
+
+    Returns meta_dir.
+    '''
+    # TODO keys for using apparmor, setting an icon missing.
+
+    meta_dir = os.path.join(common.get_snapdir(), 'meta')
+    os.makedirs(meta_dir, exist_ok=True)
+
+    _write_package_yaml(meta_dir, config_data, arches)
+    _write_readme_md(meta_dir, config_data)
+
+    return meta_dir
+
+
+def _write_package_yaml(meta_dir, config_data, arches):
+    package_yaml_path = os.path.join(meta_dir, 'package.yaml')
+    package_yaml = _compose_package_yaml(config_data, arches)
+
+    with open(package_yaml_path, 'w') as f:
+        yaml.dump(package_yaml, stream=f, default_flow_style=False)
+
+
+def _write_readme_md(meta_dir, config_data):
+    readme_md_path = os.path.join(meta_dir, 'readme.md')
+    readme_md = _compose_readme(config_data)
+
+    with open(readme_md_path, 'w') as f:
+        f.write(readme_md)
+
+
+def _compose_package_yaml(config_data, arches):
+    '''
+    Creates a dictionary that can be used to yaml.dump a package.yaml using
+    config_data.
+    If provided arches, is a list of arches.
+
+    Missing key exceptions will be raised if config_data does not hold
+    MANDATORY_KEYS, config_data can be validated against the snapcraft schema.
+    '''
+    package_yaml = {}
+
+    for key_name in _MANDATORY_PACKAGE_KEYS:
+        package_yaml[key_name] = config_data[key_name]
+
+    for key_name in _OPTIONAL_PACKAGE_KEYS:
+        if key_name in config_data:
+            package_yaml[key_name] = config_data[key_name]
+
+    if arches:
+        package_yaml['architectures'] = arches
+
+    if 'binaries' in config_data:
+        package_yaml['binaries'] = _wrap_binaries(config_data['binaries'])
+
+    if 'services' in config_data:
+        package_yaml['services'] = _wrap_services(config_data['services'])
+
+    return package_yaml
+
+
+def _compose_readme(config_data):
+    return '{config[summary]}\n{config[description]}\n'.format(config=config_data)
+
+
+def _replace_cmd(execparts, cmd):
+        newparts = [cmd] + execparts[1:]
+        return ' '.join([shlex.quote(x) for x in newparts])
+
+
+def _wrap_exe(relexepath):
+    snap_dir = common.get_snapdir()
+    exepath = os.path.join(snap_dir, relexepath)
+    wrappath = exepath + '.wrapper'
+
+    # TODO talk to original author if the exception to be captured here is
+    # FileNotFoundError, the original code was a general catch all
+    try:
+        os.remove(wrappath)
+    except FileNotFoundError:
+        pass
+
+    wrapexec = '$SNAP_APP_PATH/{}'.format(relexepath)
+    if not os.path.exists(exepath) and '/' not in relexepath:
+        # If it doesn't exist it might be in the path
+        logger.debug('Checking to see if "{}" is in the $PATH'.format(relexepath))
+        with tempfile.NamedTemporaryFile('w+') as tempf:
+            script = ('#!/bin/sh\n' +
+                      '{}\n'.format(common.assemble_env()) +
+                      'which "{}"\n'.format(relexepath))
+            tempf.write(script)
+            tempf.flush()
+            if common.run(['/bin/sh', tempf.name], cwd=snap_dir):
+                wrapexec = relexepath
+            else:
+                logger.warning('Warning: unable to find "{}" in the path'.format(relexepath))
+
+    assembled_env = common.assemble_env().replace(snap_dir, '$SNAP_APP_PATH')
+    script = ('#!/bin/sh\n' +
+              '{}\n'.format(assembled_env) +
+              'exec "{}" $*\n'.format(wrapexec))
+
+    with open(wrappath, 'w+') as f:
+        f.write(script)
+
+    os.chmod(wrappath, 0o755)
+
+    return os.path.relpath(wrappath, snap_dir)
+
+
+def _wrap_binaries(binaries):
+    for binary in binaries:
+        execparts = shlex.split(binary.get('exec', binary['name']))
+        execwrap = _wrap_exe(execparts[0])
+        if 'exec' in binary:
+            binary['exec'] = _replace_cmd(execparts, execwrap)
+        else:
+            binary['name'] = os.path.basename(binary['name'])
+            binary['exec'] = _replace_cmd(execparts, execwrap)
+
+    return binaries
+
+
+def _wrap_services(services):
+    for binary in services:
+        startpath = binary.get('start')
+        if startpath:
+            startparts = shlex.split(startpath)
+            startwrap = _wrap_exe(startparts[0])
+            binary['start'] = _replace_cmd(startparts, startwrap)
+        stoppath = binary.get('stop')
+        if stoppath:
+            stopparts = shlex.split(stoppath)
+            stopwrap = _wrap_exe(stopparts[0])
+            binary['stop'] = _replace_cmd(stopparts, stopwrap)
+
+    return services

=== modified file 'snapcraft/tests/test_cmds.py'
--- snapcraft/tests/test_cmds.py	2015-08-05 15:39:18 +0000
+++ snapcraft/tests/test_cmds.py	2015-08-27 16:38:02 +0000
@@ -23,7 +23,6 @@
 
 from snapcraft import (
     cmds,
-    common,
     tests
 )
 
@@ -97,21 +96,3 @@
         self.assertEqual(
             'Wrote the following as snapcraft.yaml.\n',
             fake_logger.output)
-
-
-class WrapExeTestCase(tests.TestCase):
-
-    def test_wrap_exe_must_write_wrapper(self):
-        snapdir = common.get_snapdir()
-        os.mkdir(snapdir)
-        relative_exe_path = 'test_relexepath'
-        relative_wrapper_path = cmds.wrap_exe(relative_exe_path)
-        wrapper_path = os.path.join(snapdir, relative_wrapper_path)
-
-        expected = ('#!/bin/sh\n'
-                    '\n'
-                    'exec "$SNAP_APP_PATH/test_relexepath" $*\n')
-        with open(wrapper_path, 'r') as wrapper_file:
-            wrapper_contents = wrapper_file.read()
-
-        self.assertEqual(expected, wrapper_contents)

=== added file 'snapcraft/tests/test_meta.py'
--- snapcraft/tests/test_meta.py	1970-01-01 00:00:00 +0000
+++ snapcraft/tests/test_meta.py	2015-08-27 16:38:02 +0000
@@ -0,0 +1,258 @@
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2015 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+from unittest.mock import (
+    Mock,
+    call,
+    mock_open,
+    patch,
+)
+
+from snapcraft import (
+    common,
+    meta,
+    tests
+)
+
+
+class ComposeTestCase(tests.TestCase):
+
+    def setUp(self):
+        super().setUp()
+        patcher = patch('snapcraft.meta._wrap_exe')
+        mock_wrap_exe = patcher.start()
+        mock_wrap_exe.return_value = 'binary.wrapped'
+        self.addCleanup(patcher.stop)
+
+        self.config_data = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+        }
+
+    def test_plain_no_binaries_or_services(self):
+
+        y = meta._compose_package_yaml(self.config_data, ['armhf', 'amd64'])
+
+        expected = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+            'architectures': ['armhf', 'amd64'],
+        }
+
+        self.assertEqual(y, expected)
+
+    def test_plain_no_binaries_or_services_or_arches(self):
+
+        y = meta._compose_package_yaml(self.config_data, None)
+
+        expected = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+        }
+
+        self.assertEqual(y, expected)
+
+    def test_with_binaries(self):
+        self.config_data['binaries'] = [
+            {
+                'name': 'binary1',
+                'exec': 'binary1.sh go',
+            },
+            {
+                'name': 'binary2',
+            },
+        ]
+
+        y = meta._compose_package_yaml(self.config_data, ['armhf', 'amd64'])
+
+        expected = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+            'architectures': ['armhf', 'amd64'],
+            'binaries': [
+                {
+                    'name': 'binary1',
+                    'exec': 'binary.wrapped go',
+                },
+                {
+                    'name': 'binary2',
+                    'exec': 'binary.wrapped',
+                },
+            ],
+        }
+
+        self.assertEqual(y, expected)
+
+    def test_with_services(self):
+        self.config_data['services'] = [
+            {
+                'name': 'service1',
+                'start': 'binary1',
+            },
+            {
+                'name': 'service2',
+                'start': 'binary2 --start',
+                'stop': 'binary2 --stop',
+            },
+            {
+                'name': 'service3',
+            },
+        ]
+
+        y = meta._compose_package_yaml(self.config_data, ['armhf', 'amd64'])
+
+        expected = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+            'architectures': ['armhf', 'amd64'],
+            'services': [
+                {
+                    'name': 'service1',
+                    'start': 'binary.wrapped',
+                },
+                {
+                    'name': 'service2',
+                    'start': 'binary.wrapped --start',
+                    'stop': 'binary.wrapped --stop',
+                },
+                {
+                    'name': 'service3',
+                }
+            ],
+        }
+
+        self.assertEqual(y, expected)
+
+    def test_plain_no_binaries_or_services_with_optionals(self):
+        self.config_data['frameworks'] = ['mir', ]
+
+        y = meta._compose_package_yaml(self.config_data, ['armhf', 'amd64'])
+
+        expected = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+            'architectures': ['armhf', 'amd64'],
+            'frameworks': ['mir', ],
+        }
+
+        self.assertEqual(y, expected)
+
+    def test_compose_readme(self):
+        self.config_data['summary'] = 'one line summary'
+        self.config_data['description'] = 'the description\nwhich can be longer'
+
+        readme_text = '''one line summary
+the description
+which can be longer
+'''
+
+        self.assertEqual(meta._compose_readme(self.config_data), readme_text)
+
+
+class Create(tests.TestCase):
+
+    def setUp(self):
+        super().setUp()
+        self.orig_os_makedirs = os.makedirs
+
+        self.config_data = {
+            'name': 'my-package',
+            'version': '1.0',
+            'vendor': 'Sergio Schvezov <[e-mail]>',
+            'description': 'my description',
+            'summary': 'my summary',
+        }
+
+    def tearDown(self):
+        super().tearDown()
+        os.makedirs = self.orig_os_makedirs
+
+    def test_create_meta(self):
+        os.makedirs = Mock()
+        mock_the_open = mock_open()
+
+        with patch('snapcraft.meta.open', mock_the_open, create=True):
+            meta.create(self.config_data, ['amd64'])
+
+        meta_dir = os.path.join(os.path.abspath(os.curdir), 'snap', 'meta')
+
+        os.makedirs.assert_called_once_with(meta_dir, exist_ok=True)
+
+        mock_the_open.assert_has_calls([
+            call(os.path.join(meta_dir, 'package.yaml'), 'w'),
+            call().__enter__(),
+            call().write('architectures'),
+            call().write(':'),
+            call().write('\n'),
+            call().write('-'),
+            call().write(' '),
+            call().write('amd64'),
+            call().write('\n'),
+            call().write('name'),
+            call().write(':'),
+            call().write(' '),
+            call().write('my-package'),
+            call().write('\n'),
+            call().write('vendor'),
+            call().write(':'),
+            call().write(' '),
+            call().write('Sergio'),
+            call().write(' '),
+            call().write('Schvezov'),
+            call().write(' '),
+            call().write('<[e-mail]>'),
+            call().write('\n'),
+            call().write('version'),
+            call().write(':'),
+            call().write(" '"),
+            call().write('1.0'),
+            call().write("'"),
+            call().write('\n'),
+            call().flush(),
+            call().flush(),
+            call().__exit__(None, None, None),
+            call(os.path.join(meta_dir, 'readme.md'), 'w'),
+            call().__enter__(),
+            call().write('my summary\nmy description\n'),
+            call().__exit__(None, None, None),
+        ]
+        )
+
+
+# TODO this needs more tests.
+class WrapExeTestCase(tests.TestCase):
+
+    def test_wrap_exe_must_write_wrapper(self):
+        snapdir = common.get_snapdir()
+        os.mkdir(snapdir)
+        relative_exe_path = 'test_relexepath'
+        relative_wrapper_path = meta._wrap_exe(relative_exe_path)
+        wrapper_path = os.path.join(snapdir, relative_wrapper_path)
+
+        expected = ('#!/bin/sh\n'
+                    '\n'
+                    'exec "$SNAP_APP_PATH/test_relexepath" $*\n')
+        with open(wrapper_path) as wrapper_file:
+            wrapper_contents = wrapper_file.read()
+
+        self.assertEqual(expected, wrapper_contents)