Solved

shell scripting coding guidelines /checklist

Posted on 2015-01-05
7
85 Views
Last Modified: 2015-02-09
Hi ,

Can you please share any coding guidelines / standards available for shell scripting ?

Thanks,
Magento
0
Comment
Question by:magento
  • 4
  • 2
7 Comments
 
LVL 84

Expert Comment

by:ozo
Comment Utility
Which shell?
0
 
LVL 5

Author Comment

by:magento
Comment Utility
Ozo ,

I am planning to use BASH.

Thanks
0
 
LVL 1

Assisted Solution

by:jsaun
jsaun earned 500 total points
Comment Utility
There are some style guides out there that you can read.  Take the good parts, and have good reasons for what you disagree with.   Mostly check with your client or employer and see what they require.

My top tenets:

Make your code read like prose.  Long, descriptive variable names are more clear for others to understand when they come along years later to tweak your code.  This means never use a loop iterator named "i".  If you're looping over servers in a list, then do something like  
for currentServer  in $serverList

Plan it out before you start writing it.  Remember doing flowcharts in college?  It's still a good idea.  Diagrams help you make sensible functions, and help you discover corner cases before you're coding.

Have someone buddy check as you go along, and test frequently.  

Write your test cases before you write your code.

Here are some style guide links:

http://wiki.bash-hackers.org/scripting/style
https://google-styleguide.googlecode.com/svn/trunk/shell.xml
http://tldp.org/LDP/abs/html/scrstyle.html

Cheers and good luck
0
What Security Threats Are You Missing?

Enhance your security with threat intelligence from the web. Get trending threat insights on hackers, exploits, and suspicious IP addresses delivered to your inbox with our free Cyber Daily.

 
LVL 5

Author Comment

by:magento
Comment Utility
Hello Jsaun,

Thanks for the ideas, i will follow it.
I am new here, can you please share knowledge on writing test cases ?

Thanks
0
 
LVL 1

Accepted Solution

by:
jsaun earned 500 total points
Comment Utility
If your script expects input, test it with invalid input (as well as valid).  Typos, nulls, negative numbers, spelling errors.

If your script connects to a resource, how does it behave if the resource is not available?

If your script might be called by a hacker, check for stuff like SQL injection.   The best rule is: only accept data you are expecting to see.  If the data looks bad, better to fail safe.

That sort of thing.

And in a related note:  write out lots of logging data.  Logs help you find and fix problems later.  If you want to get fancy, you can put a debug switch in and use that to turn off most of the logging later on, but rarely will you regret having good logs
0
 
LVL 5

Author Comment

by:magento
Comment Utility
Exactly what i'm looking for . Thank you so much !!!
0
 
LVL 5

Author Closing Comment

by:magento
Comment Utility
jsaun,Thanks again!!!
0

Featured Post

Enabling OSINT in Activity Based Intelligence

Activity based intelligence (ABI) requires access to all available sources of data. Recorded Future allows analysts to observe structured data on the open, deep, and dark web.

Join & Write a Comment

The following is a collection of cases for strange behaviour when using advanced techniques in DOS batch files. You should have some basic experience in batch "programming", as I'm assuming some knowledge and not further explain the basics. For some…
Background Still having to process all these year-end "csv" files received from all these sources (including Government entities), sometimes we have the need to examine the contents due to data error, etc... As a "Unix" shop, our only readily …
Learn several ways to interact with files and get file information from the bash shell. ls lists the contents of a directory: Using the -a flag displays hidden files: Using the -l flag formats the output in a long list: The file command gives us mor…
When you create an app prototype with Adobe XD, you can insert system screens -- sharing or Control Center, for example -- with just a few clicks. This video shows you how. You can take the full course on Experts Exchange at http://bit.ly/XDcourse.

771 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

11 Experts available now in Live!

Get 1:1 Help Now