DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (0c3bc698f640)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/*
** File:        env.c
** Description: Testing environment variable operations
**
*/
#include "prenv.h"
#include "prmem.h"
#include "plgetopt.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

PRIntn  debug = 0;
PRIntn  verbose = 0;
PRIntn  secure = 0;
PRBool  failedAlready = PR_FALSE;

#define  ENVNAME    "NSPR_ENVIRONMENT_TEST_VARIABLE"
#define  ENVVALUE   "The expected result"
#define  ENVBUFSIZE 256

char    *envBuf; /* buffer pointer. We leak memory here on purpose! */

static char * NewBuffer( size_t size )
{
    char *buf = malloc( size );
    if ( NULL == buf ) {
        printf("env: NewBuffer() failed\n");
        exit(1);
    }
    return(buf);
} /* end NewBuffer() */

int main(int argc, char **argv)
{
    char    *value;
    PRStatus    rc;

    {   /* Get command line options */
        PLOptStatus os;
        PLOptState *opt = PL_CreateOptState(argc, argv, "vds");

        while (PL_OPT_EOL != (os = PL_GetNextOpt(opt)))
        {
            if (PL_OPT_BAD == os) {
                continue;
            }
            switch (opt->option)
            {
                case 'd':  /* debug */
                    debug = 1;
                    break;
                case 'v':  /* verbose */
                    verbose = 1;
                    break;
                case 's':  /* secure / set[ug]id */
                    /*
                    ** To test PR_GetEnvSecure, make this executable (or a
                    ** copy of it) setuid / setgid / otherwise inherently
                    ** privileged (e.g., file capabilities) and run it
                    ** with this flag.
                    */
                    secure = 1;
                    break;
                default:
                    break;
            }
        }
        PL_DestroyOptState(opt);
    } /* end block "Get command line options" */

#if 0
    {
        /*
        ** This uses Windows native environment manipulation
        ** as an experiment. Note the separation of namespace!
        */
        BOOL rv;
        DWORD   size;
        rv = SetEnvironmentVariable( ENVNAME, ENVVALUE );
        if ( rv == 0 )  {
            if (debug) {
                printf("env: Shit! SetEnvironmentVariable() failed\n");
            }
            failedAlready = PR_TRUE;
        }
        if (verbose) {
            printf("env: SetEnvironmentVariable() worked\n");
        }

        size = GetEnvironmentVariable( ENVNAME, envBuf, ENVBUFSIZE );
        if ( size == 0 )  {
            if (debug) {
                printf("env: Shit! GetEnvironmentVariable() failed. Found: %s\n", envBuf );
            }
            failedAlready = PR_TRUE;
        }
        if (verbose) {
            printf("env: GetEnvironmentVariable() worked. Found: %s\n", envBuf);
        }

        value = PR_GetEnv( ENVNAME );
        if ( (NULL == value ) || (strcmp( value, ENVVALUE)))  {
            if (debug) {
                printf( "env: PR_GetEnv() failed retrieving WinNative. Found: %s\n", value);
            }
            failedAlready = PR_TRUE;
        }
        if (verbose) {
            printf("env: PR_GetEnv() worked. Found: %s\n", value);
        }
    }
#endif

    /* set an environment variable, read it back */
    envBuf = NewBuffer( ENVBUFSIZE );
    sprintf( envBuf, ENVNAME "=" ENVVALUE );
    rc = PR_SetEnv( envBuf );
    if ( PR_FAILURE == rc )  {
        if (debug) {
            printf( "env: PR_SetEnv() failed setting\n");
        }
        failedAlready = PR_TRUE;
    } else {
        if (verbose) {
            printf("env: PR_SetEnv() worked.\n");
        }
    }

    value = PR_GetEnv( ENVNAME );
    if ( (NULL == value ) || (strcmp( value, ENVVALUE)))  {
        if (debug) {
            printf( "env: PR_GetEnv() Failed after setting\n" );
        }
        failedAlready = PR_TRUE;
    } else {
        if (verbose) {
            printf("env: PR_GetEnv() worked after setting it. Found: %s\n", value );
        }
    }

    if ( secure ) {
        /*
        ** In this case we've been run with elevated privileges, so
        ** test that PR_GetEnvSecure *doesn't* find that env var.
        */
        value = PR_GetEnvSecure( ENVNAME );
        if ( NULL != value ) {
            if (debug) {
                printf( "env: PR_GetEnvSecure() failed; expected NULL, found \"%s\"\n", value );
            }
            failedAlready = PR_TRUE;
        } else {
            if (verbose) {
                printf("env: PR_GetEnvSecure() worked\n" );
            }
        }
    } else {
        /*
        ** In this case the program is being run normally, so do the
        ** same check for PR_GetEnvSecure as for PR_GetEnv.
        */
        value = PR_GetEnvSecure( ENVNAME );
        if ( (NULL == value ) || (strcmp( value, ENVVALUE)))  {
            if (debug) {
                printf( "env: PR_GetEnvSecure() Failed after setting\n" );
            }
            failedAlready = PR_TRUE;
        } else {
            if (verbose) {
                printf("env: PR_GetEnvSecure() worked after setting it. Found: %s\n", value );
            }
        }
    }

    /* ---------------------------------------------------------------------- */
    /* check that PR_DuplicateEnvironment() agrees with PR_GetEnv() */
    {
#if defined(XP_UNIX) && (!defined(DARWIN) || defined(HAVE_CRT_EXTERNS_H))
        static const PRBool expect_failure = PR_FALSE;
#else
        static const PRBool expect_failure = PR_TRUE;
#endif
        char **i, **dupenv = PR_DuplicateEnvironment();


        if ( NULL == dupenv ) {
            if (expect_failure) {
                if (verbose) printf("env: PR_DuplicateEnvironment failed, "
                                        "as expected on this platform.\n");
            } else {
                if (debug) {
                    printf("env: PR_DuplicateEnvironment() failed.\n");
                }
                failedAlready = PR_TRUE;
            }
        } else {
            unsigned found = 0;

            if (expect_failure) {
                if (debug) printf("env: PR_DuplicateEnvironment() succeeded, "
                                      "but failure is expected on this platform.\n");
                failedAlready = PR_TRUE;
            } else {
                if (verbose) {
                    printf("env: PR_DuplicateEnvironment() succeeded.\n");
                }
            }
            for (i = dupenv; *i; i++) {
                char *equals = strchr(*i, '=');

                if ( equals == NULL ) {
                    if (debug) printf("env: PR_DuplicateEnvironment() returned a string"
                                          " with no '=': %s\n", *i);
                    failedAlready = PR_TRUE;
                } else {
                    /* We own this string, so we can temporarily alter it */
                    /* *i is the null-terminated name; equals + 1 is the value */
                    *equals = '\0';

                    if ( strcmp(*i, ENVNAME) == 0) {
                        found++;
                        if (verbose) printf("env: PR_DuplicateEnvironment() found " ENVNAME
                                                " (%u so far).\n", found);
                    }

                    /* Multiple values for the same name can't happen, according to POSIX. */
                    value = PR_GetEnv(*i);
                    if ( value == NULL ) {
                        if (debug) printf("env: PR_DuplicateEnvironment() returned a name"
                                              " which PR_GetEnv() failed to find: %s\n", *i);
                        failedAlready = PR_TRUE;
                    } else if ( strcmp(equals + 1, value) != 0) {
                        if (debug) printf("env: PR_DuplicateEnvironment() returned the wrong"
                                              " value for %s: expected %s; found %s\n",
                                              *i, value, equals + 1);
                        failedAlready = PR_TRUE;
                    } else {
                        if (verbose) printf("env: PR_DuplicateEnvironment() agreed with"
                                                " PR_GetEnv() about %s\n", *i);
                    }
                }
                PR_Free(*i);
            }
            PR_Free(dupenv);

            if (found != 1) {
                if (debug) printf("env: PR_DuplicateEnvironment() found %u entries for " ENVNAME
                                      " (expected 1)\n", found);
                failedAlready = PR_TRUE;
            } else {
                if (verbose) {
                    printf("env: PR_DuplicateEnvironment() found 1 entry for " ENVNAME "\n");
                }
            }
        }
    }

    /* ---------------------------------------------------------------------- */
    /* un-set the variable, using RAW name... should not work */
    envBuf = NewBuffer( ENVBUFSIZE );
    sprintf( envBuf, ENVNAME );
    rc = PR_SetEnv( envBuf );
    if ( PR_FAILURE == rc )  {
        if (verbose) {
            printf( "env: PR_SetEnv() not un-set using RAW name. Good!\n");
        }
    } else {
        if (debug) {
            printf("env: PR_SetEnv() un-set using RAW name. Bad!\n" );
        }
        failedAlready = PR_TRUE;
    }

    value = PR_GetEnv( ENVNAME );
    if ( NULL == value ) {
        if (debug) {
            printf("env: PR_GetEnv() after un-set using RAW name. Bad!\n" );
        }
        failedAlready = PR_TRUE;
    } else {
        if (verbose) {
            printf( "env: PR_GetEnv() after RAW un-set found: %s\n", value );
        }
    }

    /* ---------------------------------------------------------------------- */
    /* set it again ... */
    envBuf = NewBuffer( ENVBUFSIZE );
    sprintf( envBuf, ENVNAME "=" ENVVALUE );
    rc = PR_SetEnv( envBuf );
    if ( PR_FAILURE == rc )  {
        if (debug) {
            printf( "env: PR_SetEnv() failed setting the second time.\n");
        }
        failedAlready = PR_TRUE;
    } else {
        if (verbose) {
            printf("env: PR_SetEnv() worked.\n");
        }
    }

    /* un-set the variable using the form name= */
    envBuf = NewBuffer( ENVBUFSIZE );
    sprintf( envBuf, ENVNAME "=" );
    rc = PR_SetEnv( envBuf );
    if ( PR_FAILURE == rc )  {
        if (debug) {
            printf( "env: PR_SetEnv() failed un-setting using name=\n");
        }
        failedAlready = PR_TRUE;
    } else {
        if (verbose) {
            printf("env: PR_SetEnv() un-set using name= worked\n" );
        }
    }

    value = PR_GetEnv( ENVNAME );
    if (( NULL == value ) || ( 0x00 == *value )) {
        if (verbose) {
            printf("env: PR_GetEnv() after un-set using name= worked\n" );
        }
    } else {
        if (debug) {
            printf( "env: PR_GetEnv() after un-set using name=. Found: %s\n", value );
        }
        failedAlready = PR_TRUE;
    }
    /* ---------------------------------------------------------------------- */
    /* un-set the variable using the form name= */
    envBuf = NewBuffer( ENVBUFSIZE );
    sprintf( envBuf, ENVNAME "999=" );
    rc = PR_SetEnv( envBuf );
    if ( PR_FAILURE == rc )  {
        if (debug) {
            printf( "env: PR_SetEnv() failed un-setting using name=\n");
        }
        failedAlready = PR_TRUE;
    } else {
        if (verbose) {
            printf("env: PR_SetEnv() un-set using name= worked\n" );
        }
    }

    value = PR_GetEnv( ENVNAME "999" );
    if (( NULL == value ) || ( 0x00 == *value )) {
        if (verbose) {
            printf("env: PR_GetEnv() after un-set using name= worked\n" );
        }
    } else {
        if (debug) {
            printf( "env: PR_GetEnv() after un-set using name=. Found: %s\n", value );
        }
        failedAlready = PR_TRUE;
    }

    /* ---------------------------------------------------------------------- */
    if (debug || verbose) {
        printf("\n%s\n", (failedAlready)? "FAILED" : "PASSED" );
    }
    return( (failedAlready)? 1 : 0 );
}  /* main() */

/* env.c */