Drush integration for demo module

#1

Posted by sivaji on March 27, 2010 at 6:22pm

Title:	Drush Support	» Drush integration for demo module
Assigned to:	Anonymous	» sivaji

I am currently working on this. I will submit a patch tomorrow.

Login or register to post comments

Attachment	Size
demo-678792-drush-integration.patch	8.22 KB

Attachment	Size
demo-678792-drush-integration.patch	8.22 KB

#5

Posted by TravisCarden on April 11, 2010 at 12:11am

Also, could we shorten demo-snapshotsto, say, demo-list? It's less to type, and I for one find it much easier to remember. (I have to stop and think every time to remember "snapshots".) If not, perhaps we could get a shorthand version of it.

Speaking of which, perhaps we should add a command alias for demo-delete, such as demo-del, in keeping with the precedent set by Drush core (e.g. variable-delete (vdel) and watchdog-delete (wd-del)).

Finally, I wonder if there would be value in adding, say, a demo-info command to get more detail on a particular snapshot (namely, a list of the modules installed, as you would find on the web interface) similar to pm-info for modules. Hopefully that's the last thought I'll have on this tonight. :)

Login or register to post comments

#6

Posted by sivaji on April 16, 2010 at 2:56pm

Creating a snapshot through the web interface and through Drush resulted in backups of the same file size, which is good

I guess MD5 checksum is the ideal way to cross check this.

can execute the commands from Drush even if the module's not enabled

This is true (for instance see below), could be a bug in drush.

$ drush pm-list | grep -i demo
 Demonstration site (demo)                                         Module  Not installed                 
 Demonstration site reset (demo_reset)                             Module  Not installed                 
$ drush demo-snapshots
 File name           Date              Size       Description                    
 snapshot-v1.0       2010-03-29 02:11  436.91 KB  First version                  
 simple_reservation  2010-04-05 23:22  484.54 KB  simple_reservation module done 
 snapshot-Mon        2010-03-29 02:05  436.72 KB  Mar                      

demo-snapshots should sort the snapshots by date the way the web interface does

Done, now it will list items sorted by modification date, recently modified file will appear first.

There should probably be a drush_confirm when deleting a snapshot.

It makes sense. Added drush_confirm for delete command.

One more thing: It looks like if none of your snapshots have any description, it mucks up the table headings in the output of demo-snapshots:

I can reproduce that only when the console width is small like 80x24 otherwise it looks fine. It is drush_print_table() API generating the table with dynamic width for columns. It turns too bad if i set width manually.

could we shorten demo-snapshotsto, say, demo-list?

I like to go with following set of alias.
command alias
demo-create demo-mk
demo-delete demo-rm
demo-reset demo-rs
demo-snapshots demo-ss
demo-status demo-st

Let me know what you think about this.

Attachment	Size
demo-678792-drush-integration.patch_6.patch	9.65 KB

Login or register to post comments

#7

Posted by TravisCarden on April 17, 2010 at 3:48am

I compared the contents of a snapshot created through the web interface with those of one created with Drush, and they were identical except for a little session data, which is to be expected. So it looks like we're good on that front.

Your changes look great! I like how your first two command aliases (demo-mk and demo-rm) mirror corresponding Linux commands. That was smart. Unless the other three also mirror common commands I'm unfamiliar with (I'm a bit of a Linux n00b) I'd personally just omit them and suggest demo-list as an alias for demo-snapshots, but as you're the one doing all the work here, I happily defer to your judgment. :)

I also proofread all the messages in the code and corrected a dozen or so typos and grammatical errors and made small changes to wording to maintain consistency with core Drush messages (mostly changing verb tenses). I also deleted a TODO that had been completed. Here's a new patch.

Attachment	Size
demo-678792-drush-integration.patch	9.62 KB

Login or register to post comments

#8

Posted by TravisCarden on April 17, 2010 at 4:03am

Uh-oh. Suddenly demo-delete isn't working for me, but I'm getting a PHP error instead of a Drush message:

# drush demo-mk test
Successfully created snapshot sites/all/files/demo/test.sql                                                                                          [ok]
# drush demo-rm test -y
This command will delete the snapshot and can not be undone                                                                                          [warning]
Are you sure you want to continue? (y/n): y
WD php: unlink(): No such file or directory in /home/bigfatug/public_html/test/sites/all/modules/contrib/demo/demo.drush.inc on line 178.            [error]
WD php: unlink(): No such file or directory in /home/bigfatug/public_html/test/sites/all/modules/contrib/demo/demo.drush.inc on line 179.            [error]
Deleted snapshot test                                                                                                                                [success]

Is it still working for you, @sivaji? I don't think I changed anything that should have broken it, but I don't have time to test further tonight.

Login or register to post comments

#9

Posted by sivaji on April 17, 2010 at 12:42pm

Thanks for correcting typos and grammars.

Aha that's my change in patch #6 breaking delete command, attached patch will fix that. I like to use demo-ls (similar to demo-mk and demo-rm) as an alias for demo-snapshots. Let's see what others think and will choose the best one.

Hopefully everything is working fine now, i am curious to hear from tha_sun (I remember i have to update #754798: Default dump file name will do later today.)

Attachment	Size
demo-678792-drush-integration_9.patch	9.67 KB

Login or register to post comments

#10

Posted by TravisCarden on April 18, 2010 at 12:12am

Good thinking with demo-ls; I like it. demo-delete works again.

Login or register to post comments

#11

Posted by TravisCarden on April 22, 2010 at 3:37am

I've been looking at drush_print_table and drush_table_column_autowidth to see if I could identify the problem reported in comment #4 as belonging to Drush core, and I can't replicate the issue with any other commands. On the other hand, if I comment out line 197 of demo.drush.inc, I don't have the problem with demo-snapshots anymore, either.

<?php
// Line 197:
$rows[time()] = array('File name', 'Date', 'Size', 'Description');
?>

Does that suggest anything to you, @sivaji? I can't see what could be wrong with demo.drush.inc, but I can't seem to "break" anything else.

Login or register to post comments

#12

Posted by winston on May 22, 2010 at 11:58pm

Don't want to make this into a support request, but it might have relevance for this patch.

Does demo module have a concept of what is the "currently applied" demo snapshot?

If so, then a demo-update drush command to simply apply the current database state to the current applied snapshot would be helpful. Then again, perhaps this isn't such a good thing?

Here is my use case for reference. I'm using demo module to build a series of demo snapshots for a training course. The snapshots allow a student to "fast forward" to a specific point in the class (or catch up, etc.). What I'd like to be able to do is write a script using drush that will go through all the demo snapshots available, apply them, do a drush up to ensure they have the latest recommended versions of each module + update.php. That would be slightly simpler if a drush demo-update were possible so my script would use your drush demo-ls to get a list of the snapshots then looping through each one...

drush demo-reset "next one"
drush up
drush demo-update
loop

Anyway really glad drush integration is so close!

Login or register to post comments

#13

Posted by TravisCarden on May 24, 2010 at 1:48pm

I'm not entirely sure I understand the request, @winston. Your thought is that demo-update would detect which snapshot the current state of the site reflected? In other words, it would compare your site with your snapshots and say, "This is the snapshot that your current site is based on". My first thought is that that isn't really feasible because the live database will have changed from the snapshot, even if only with respect to the sessions and logs. There are perhaps a few ways it could be basically accomplished, but those that I can think of would be either extremely complicated and resource-intensive or hacky. In short, it would involve the addition, not merely of a Drush interface, but a whole new feature to Demo module itself; for which reason I would encourage you, if you wish to pursue it, to open a separate feature request issue. As to your plan to create a script to loop through snapshots applying them, you should only need to apply the latest one, because each snapshot is a complete export of the database and stands alone. Applying several serially will have the exact same effect as just applying the last one. Best wishes!

Login or register to post comments

#14

Posted by auzigog on August 27, 2010 at 10:01am

Hey all. I'm interested in this support.

It seems to have stalled. How can I help move it forward from where it is currently at?

Login or register to post comments

#15

Posted by winston on August 30, 2010 at 10:16pm

@TravisCarden

Yes, you're right my request doesn't make any sense :/

However, I do think this functionality as discussed will be helpful for me as I should be able to do what I want with a regular shell script with this functionality available to Drush. Basically I'd like to be able to loop through a set of snapshots (which I would be able to get from list), apply them, do a drush up after the snapshot is applied, then create the snapshot again.

Login or register to post comments

#16

Posted by TravisCarden on August 31, 2010 at 3:40am

@auzigog: Thanks for asking! You could test the patch in #9 and give your feedback. We've only had two eyes on it so far. Also, there's a bit of a rendering issue described in #4 and #11 that you could help us diagnose—or at least confirm it still exists. That would be a big help!

@winston: I still don't understand the need to loop through a set of snapshots, because snapshots aren't cumulative. Each one is a full database dump. If you apply one from yesterday, drush up, and then apply one from today, whatever changes were made to the database via drush up will be overwritten and lost when you apply the second snapshot. You'll have to drush up. Just applying the very latest snapshot and doing a drush up would have the same result (and, obviously, be much easier). If you still feel you need the functionality, please create a new support request. Thanks!

Project:	Demonstration site (Sandbox / Snapshot)
Version:	6.x-1.x-dev
Component:	Code
Category:	feature request
Priority:	normal
Assigned:	sivaji
Status:	needs review
Issue tags:	drush

Drush integration for demo module

Jump to:

Issue Summary

Comments

#1

#2

#3

#4

#5

#6

#7

#8

#9

#10

#11

#12

#13

#14

#15

#16

#17