Bug 806747 - RFE: Suppress "ERROR" message on config file initialization
Summary: RFE: Suppress "ERROR" message on config file initialization
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: PressGang CCMS
Classification: Community
Component: CSProcessor
Version: 1.x
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Lee Newson
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-03-26 07:06 UTC by Joshua Wulf
Modified: 2014-10-19 23:00 UTC (History)
2 users (show)

Fixed In Version: 0.22.5
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-06-07 01:29:46 UTC


Attachments (Terms of Use)

Description Joshua Wulf 2012-03-26 07:06:50 UTC
cspclient-0.22.4-1.noarch

At the moment, the first time you run the csprocessor you get this output:

[jwulf@dhcp-1-77 Downloads]$ csprocessor list
CSProcessor client version: 0.22.4
Creating the default configuration file: /home/jwulf/.config/csprocessor.ini
Loading configuration from /home/jwulf/.config/csprocessor.ini
ERROR: No default server was found in the /home/jwulf/.config/csprocessor.ini configuration file. Perhaps you need to uncomment a default?

Under normal circumstances the lack of a default server is an error condition, but on the first run (when a config file is initialized) it's expected behaviour.

So perhaps it would be more reassuring for users to detect that, and in the case where the csprocessor initialises its own config file it could say something like:

[jwulf@dhcp-1-77 Downloads]$ csprocessor list
CSProcessor client version: 0.22.4
Creating the default configuration file: /home/jwulf/.config/csprocessor.ini
Edit /home/jwulf/.config/csprocessor.ini to configure your username(s) and default server

Maybe something like setting a bit during the csprocessor operation - "if the config file was created by csprocessor during the current operation, show message B; otherwise show message A".

It seems like a small thing, but a hand-held guided tutorial at the moment runs like this:
1. Go to #skynet on IRC
2. Get the Docspace URL from the channel topic
3. Go to the Docspace page
4. Download and install the yum repo
5. Install the cspclient package
6. Run "csprocessor list" to initialise your config file
7. Edit your config file to set the default server and your username

Having an error message appear during that process is unsettling for the user. We can document "IGNORE THAT ERROR MESSAGE", but that raises the inevitable question: why isn't it suppressed?

A different approach might be to have a "csprocessor initialize" command, and the processor to say something like:

"No configuration file found at /home/<username>/.config/csprocessor.ini. Run "csprocessor initialize" to create one."

And then display the "Edit the config file" message as part of the csprocessor initialize output.

The crux of the matter:

I'd like an install and configure path with as much automated as possible (like the csprocessor creating the config file, as it does now), and with no error messages that potentially confuse new users.

Right now we have automation, but no path to avoid the error message, which isn't applicable when you are specifically running the processor to create a config file, and don't expect it to find a default server...

Comment 1 Lee Newson 2012-03-26 23:15:21 UTC
Added in 0.22.5

I've actually done both methods here. I've created a "setup" command which will allow you to setup the servers and root directory. If you use the program without setting up the csprocessor.ini it will still create the default configuration but display the error message mentioned.

If the user runs the setup command and a csprocessor.ini already exists then it will rename that file to a backup and then create the new csprocessor.ini as per the user input.

Comment 2 Lee Newson 2013-06-07 01:29:46 UTC
Closing and setting as current release as no QA was performed by the original reporter. If there is still an issue with this bug still than please re-open it.


Note You need to log in before you can comment on or make changes to this bug.