[ANN] OSSubprocess first milestone

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

[ANN] OSSubprocess first milestone

Mariano Martinez Peck
Dear all, 

I am happy to tell you I have a first prototype of the tool for executing OS processes:


 As I said many times, the main idea was to be as much as possible FFI-based, only for executing OS commands and, from my point of view, a better end-user API. Also, as for the first step, I had to focus on Linux/OSX. 

I would like to thank Pharo Consortium for the sponsor of this development effort. Here is the first milestone!

There are many things on my to-do but I think the code is ready for some usage, testing, code review and feedback!  

All classes and all methods have comments and I have quite some unit tests. All tests are green in my OSX and a CentOS box. 

Important: you CANNOT have OSProcess installed in the same image as OSSubprocess. This is because I am reusing his SIGCHLD handler and for the time being both cannot coexist.  

Keep in mind that the tool may be unstable and that MAY mean a VM crash. So use with care, mostly the first time. If all tests passes, then there are much less chances of something going bad. 

Important disclaimer: my tool (OSSubproccess from now onward) is HIGHLY influenced by a subset of the OSProcess project. There are parts which I even simply copied and adapted them (OSSPipe, OSSAttachableStream, OSSUnixProcessExitStatus). Other parts, I took them as inspiration (the idea of ThisOSProcess representing the VM process, the child watcher, and many others). In addition, I AM STILL USING (maybe as a first step?) some of the OSProcess PLUGIN (not OSProcess image side), such as the SIGCHLD handler or the creation of pipes.

In github url you have all the documentation of the project, included how to install it and use it. 

Finally, if you test it in a OS different than OSX and CentOS please share with me the results (about the tests). Tomorrow the ConfigurationOf should also appear in the Catalog of Pharo 5.0. 

Any feedback is appreciated. 

Best, 

--
Reply | Threaded
Open this post in threaded view
|

Re: [ANN] OSSubprocess first milestone

stepharo
Thanks Mariano!

Stef

Le 14/1/16 19:33, Mariano Martinez Peck a écrit :
Dear all, 

I am happy to tell you I have a first prototype of the tool for executing OS processes:


 As I said many times, the main idea was to be as much as possible FFI-based, only for executing OS commands and, from my point of view, a better end-user API. Also, as for the first step, I had to focus on Linux/OSX. 

I would like to thank Pharo Consortium for the sponsor of this development effort. Here is the first milestone!

There are many things on my to-do but I think the code is ready for some usage, testing, code review and feedback!  

All classes and all methods have comments and I have quite some unit tests. All tests are green in my OSX and a CentOS box. 

Important: you CANNOT have OSProcess installed in the same image as OSSubprocess. This is because I am reusing his SIGCHLD handler and for the time being both cannot coexist.  

Keep in mind that the tool may be unstable and that MAY mean a VM crash. So use with care, mostly the first time. If all tests passes, then there are much less chances of something going bad. 

Important disclaimer: my tool (OSSubproccess from now onward) is HIGHLY influenced by a subset of the OSProcess project. There are parts which I even simply copied and adapted them (OSSPipe, OSSAttachableStream, OSSUnixProcessExitStatus). Other parts, I took them as inspiration (the idea of ThisOSProcess representing the VM process, the child watcher, and many others). In addition, I AM STILL USING (maybe as a first step?) some of the OSProcess PLUGIN (not OSProcess image side), such as the SIGCHLD handler or the creation of pipes.

In github url you have all the documentation of the project, included how to install it and use it. 

Finally, if you test it in a OS different than OSX and CentOS please share with me the results (about the tests). Tomorrow the ConfigurationOf should also appear in the Catalog of Pharo 5.0. 

Any feedback is appreciated. 

Best, 

Reply | Threaded
Open this post in threaded view
|

Re: [ANN] OSSubprocess first milestone

kilon.alios
Awesome work Mariano , I love the documentation.

Question : Does your library use the new FFI (Unified FFi) ?

On Thu, Jan 14, 2016 at 9:36 PM stepharo <[hidden email]> wrote:
Thanks Mariano!

Stef

Le 14/1/16 19:33, Mariano Martinez Peck a écrit :
Dear all, 

I am happy to tell you I have a first prototype of the tool for executing OS processes:


 As I said many times, the main idea was to be as much as possible FFI-based, only for executing OS commands and, from my point of view, a better end-user API. Also, as for the first step, I had to focus on Linux/OSX. 

I would like to thank Pharo Consortium for the sponsor of this development effort. Here is the first milestone!

There are many things on my to-do but I think the code is ready for some usage, testing, code review and feedback!  

All classes and all methods have comments and I have quite some unit tests. All tests are green in my OSX and a CentOS box. 

Important: you CANNOT have OSProcess installed in the same image as OSSubprocess. This is because I am reusing his SIGCHLD handler and for the time being both cannot coexist.  

Keep in mind that the tool may be unstable and that MAY mean a VM crash. So use with care, mostly the first time. If all tests passes, then there are much less chances of something going bad. 

Important disclaimer: my tool (OSSubproccess from now onward) is HIGHLY influenced by a subset of the OSProcess project. There are parts which I even simply copied and adapted them (OSSPipe, OSSAttachableStream, OSSUnixProcessExitStatus). Other parts, I took them as inspiration (the idea of ThisOSProcess representing the VM process, the child watcher, and many others). In addition, I AM STILL USING (maybe as a first step?) some of the OSProcess PLUGIN (not OSProcess image side), such as the SIGCHLD handler or the creation of pipes.

In github url you have all the documentation of the project, included how to install it and use it. 

Finally, if you test it in a OS different than OSX and CentOS please share with me the results (about the tests). Tomorrow the ConfigurationOf should also appear in the Catalog of Pharo 5.0. 

Any feedback is appreciated. 

Best, 

Reply | Threaded
Open this post in threaded view
|

Re: [ANN] OSSubprocess first milestone

Mariano Martinez Peck


On Thu, Jan 14, 2016 at 4:43 PM, Dimitris Chloupis <[hidden email]> wrote:
Awesome work Mariano , I love the documentation.

Question : Does your library use the new FFI (Unified FFi) ?


It does use the new FFI which is in latest Pharo 5.0. 
The Unified FFI as far as I understand in a simple rename of a couple of things. I will have to update my code for it, yes, but should be trivial.

But..as far as I know, it has not been yet integrated into the image the changes, right?  

 
On Thu, Jan 14, 2016 at 9:36 PM stepharo <[hidden email]> wrote:
Thanks Mariano!

Stef

Le 14/1/16 19:33, Mariano Martinez Peck a écrit :
Dear all, 

I am happy to tell you I have a first prototype of the tool for executing OS processes:


 As I said many times, the main idea was to be as much as possible FFI-based, only for executing OS commands and, from my point of view, a better end-user API. Also, as for the first step, I had to focus on Linux/OSX. 

I would like to thank Pharo Consortium for the sponsor of this development effort. Here is the first milestone!

There are many things on my to-do but I think the code is ready for some usage, testing, code review and feedback!  

All classes and all methods have comments and I have quite some unit tests. All tests are green in my OSX and a CentOS box. 

Important: you CANNOT have OSProcess installed in the same image as OSSubprocess. This is because I am reusing his SIGCHLD handler and for the time being both cannot coexist.  

Keep in mind that the tool may be unstable and that MAY mean a VM crash. So use with care, mostly the first time. If all tests passes, then there are much less chances of something going bad. 

Important disclaimer: my tool (OSSubproccess from now onward) is HIGHLY influenced by a subset of the OSProcess project. There are parts which I even simply copied and adapted them (OSSPipe, OSSAttachableStream, OSSUnixProcessExitStatus). Other parts, I took them as inspiration (the idea of ThisOSProcess representing the VM process, the child watcher, and many others). In addition, I AM STILL USING (maybe as a first step?) some of the OSProcess PLUGIN (not OSProcess image side), such as the SIGCHLD handler or the creation of pipes.

In github url you have all the documentation of the project, included how to install it and use it. 

Finally, if you test it in a OS different than OSX and CentOS please share with me the results (about the tests). Tomorrow the ConfigurationOf should also appear in the Catalog of Pharo 5.0. 

Any feedback is appreciated. 

Best, 




--
Reply | Threaded
Open this post in threaded view
|

Re: [ANN] OSSubprocess first milestone

David T. Lewis
In reply to this post by Mariano Martinez Peck
On Thu, Jan 14, 2016 at 03:33:56PM -0300, Mariano Martinez Peck wrote:

> Dear all,
>
> I am happy to tell you I have a first prototype of the tool for executing
> OS processes:
>
> https://github.com/marianopeck/OSSubprocess
>
>  As I said many times, the main idea was to be as much as possible
> FFI-based, only for executing OS commands and, from my point of view, a
> better end-user API. Also, as for the first step, I had to focus on
> Linux/OSX.
>
> I would like to thank Pharo Consortium for the sponsor of this development
> effort. Here is the first milestone!

Bravo Mariano!

Dave


Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-users] [ANN] OSSubprocess first milestone

Damien Cassou-2
In reply to this post by Mariano Martinez Peck
On January 14, 2016 7:33:56 PM GMT+01:00, Mariano Martinez Peck <[hidden email]> wrote:

>Dear all,
>
>I am happy to tell you I have a first prototype of the tool for
>executing
>OS processes:
>
>https://github.com/marianopeck/OSSubprocess
>
> As I said many times, the main idea was to be as much as possible
>FFI-based, only for executing OS commands and, from my point of view, a
>better end-user API. Also, as for the first step, I had to focus on
>Linux/OSX.
>
>I would like to thank Pharo Consortium for the sponsor of this
>development
>effort. Here is the first milestone!
>
>There are many things on my to-do but I think the code is ready for
>some
>usage, testing, code review and feedback!
>
>All classes and all methods have comments and I have quite some unit
>tests.
>All tests are green in my OSX and a CentOS box.
>
>*Important: you CANNOT have OSProcess installed in the same image as
>OSSubprocess. This is because I am reusing his SIGCHLD handler and for
>the
>time being both cannot coexist.  *
>
>Keep in mind that the tool may be unstable and that MAY mean a VM
>crash. So
>use with care, mostly the first time. If all tests passes, then there
>are
>much less chances of something going bad.
>
>Important disclaimer: my tool (OSSubproccess from now onward) is HIGHLY
>influenced by a subset of the OSProcess project. There are parts which
>I
>even simply copied and adapted them (OSSPipe, OSSAttachableStream,
>OSSUnixProcessExitStatus). Other parts, I took them as inspiration (the
>idea of ThisOSProcess representing the VM process, the child watcher,
>and
>many others). In addition, I AM STILL USING (maybe as a first step?)
>some
>of the OSProcess PLUGIN (not OSProcess image side), such as the SIGCHLD
>handler or the creation of pipes.
>
>In github url you have all the documentation of the project, included
>how
>to install it and use it.
>
>*Finally, if you test it in a OS different than OSX and CentOS please
>share
>with me the results (about the tests).* Tomorrow the ConfigurationOf
>should
>also appear in the Catalog of Pharo 5.0.
>
>Any feedback is appreciated.
>
>Best,

Quick feedback:

- the API seems great
- thank you very much for the documentation
- I wonder why you pass strings for stdout and stderr instead of streams
- it would be nice to be able to subclass OSSUnixProcessExitStatus for some commands. E.g., GitProcessExitStatus could have a method isMergeConflict
- how can I implement something like tail --follow
--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-users] [ANN] OSSubprocess first milestone

Mariano Martinez Peck

Quick feedback:

- the API seems great
- thank you very much for the documentation

Thanks!
 
- I wonder why you pass strings for stdout and stderr instead of streams

In which part exactly? In the method like #runAndWaitOnExitDo: ? 
if that was the question, then I simply thought it would be easier for the user to receive strings. In fact, internally I use streams, but just when I evaluate the closure I pass #contents.  I think it's more common for users wanting a string than a stream. In either case, if they received a string they can do #readStreamDo:[]  or whatever, and if they receive a stream they can do #contents. 
 
- it would be nice to be able to subclass OSSUnixProcessExitStatus for some commands. E.g., GitProcessExitStatus could have a method isMergeConflict

That would be nice. 
 
- how can I implement something like tail --follow

I think it would be nice to how an example of this type of streaming API. Note that this goes very similar to what Luc proposes below. 

Thanks for the feedback!


--
Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-users] [ANN] OSSubprocess first milestone

Mariano Martinez Peck
In reply to this post by Mariano Martinez Peck
Luc, Damien, et all.

I implemented the kind of API Luc suggested, which was a great idea. I took also his API to answer Damien question of could we do a "tail -f" example. So I made a little example where I run "tail -f system.log" and I keep a Playground updated with the stdout :)
Here is the video:


Let me know what do you think.

Cheers,


On Fri, Jan 15, 2016 at 10:51 AM, Mariano Martinez Peck <[hidden email]> wrote:


defaultReadStreamCreationBlock: [ process createTempFileToBeUsedAsReadStreamOn: '/tmp' ];

In the readme, the piece of code containing that is a bit suspicious because it depends on the fact that the block is evaluated after the variable 'process' is assigned.

Thanks, fixed!
 I always hated the instance side nature of those methods, so I moved them to class side.


 
--
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill




--



--
Reply | Threaded
Open this post in threaded view
|

Re: [Pharo-users] [ANN] OSSubprocess first milestone

jfabry

That looks very cool to me, it would have come quite in handy for some project that I did last year ;-)

On Jan 15, 2016, at 13:13, Mariano Martinez Peck <[hidden email]> wrote:

Luc, Damien, et all.

I implemented the kind of API Luc suggested, which was a great idea. I took also his API to answer Damien question of could we do a "tail -f" example. So I made a little example where I run "tail -f system.log" and I keep a Playground updated with the stdout :)
Here is the video:


Let me know what do you think.

Cheers,



---> Save our in-boxes! http://emailcharter.org <---

Johan Fabry   -   http://pleiad.cl/~jfabry
PLEIAD and RyCh labs  -  Computer Science Department (DCC)  -  University of Chile